From f2579a2a329a847a8e05fe0549cc5923cfb08704 Mon Sep 17 00:00:00 2001 From: Kai Kitching <144362514+KaiKitKobold@users.noreply.github.com> Date: Thu, 21 Mar 2024 13:24:30 -0700 Subject: [PATCH 1/6] Update README.md Committing this will update the Read.Me, Including a table of contents, descriptions of the project, and links to documentation relating to the project. --- README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 88 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8949304e..ca97449d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,26 @@ # CloudStream -**⚠️ Warning: By default this app doesn't provide any video sources, you have to install extensions in order to add functionality to the app.** +**⚠️ Warning: By default, this app doesn't provide any video sources; you have to install extensions to add functionality to the app.** + +## Table of Contents: ++ [About Us:](#about_us) ++ [Installation Steps:](#install_rules) ++ [Contributing:](#contributing) ++ [Issues:](#issues) + + [Bugs:](#bug_report) + + [Enhancement:](#enhancment) ++ [Extension Development:](#extensions) ++ [Languauge Support:](#languages) ++ [Further Sources and Social:](#contact_and_sources) -[![Discord](https://invidget.switchblade.xyz/5Hus6fM)](https://discord.gg/5Hus6fM) + -### Features: +## About us: + +**CloudStream is an open-source Android app that streams and downloads movies, TV series, and anime. We provide all of this content ad-free and without subscription or sign-up requirements.** + +#### Features: + **AdFree**, No ads whatsoever + No tracking/analytics + Bookmarks @@ -13,7 +28,77 @@ + Chromecast + Extension system for personal customization + + +## Installation: + +Our documentation provides the steps to Install Cloudstream. The steps are simple and extensively customizable for your streaming needs! + +[Getting Started With CloudStream:](https://recloudstream.github.io/csdocs/) + + + +## Contributing: +We **happily** accept any contributions to our project. To find out where you can start contributing towards the project, please look [at our issues tab](/cloudstream/issues) +While we do not have intensive syntax rules for pull requests, it's appreciated that you follow the following rules when creating an issue: + + + +### Issues: +While we **actively** accept issues and pull requests, we do not have any syntaxial rules; for issue contributions, however, it is heavily appreciated if your issue includes the following: + + + +#### Bug Reports: ++ A Short but Descriptive Title that accurately describes the bug and the issue. ++ Steps to reproduce: Make sure that the bug is reproducible And describe the steps in brief but descriptive steps ++ Make sure you include the version and the commit hash of the version of CloudStream that the bug appeared in ++ Make sure you include a description of the expected behavior of the program and the actual behavior of the bug ++ Make sure to include the "bug" label for the issue + + + +#### Enhancement: ++ Before you add your Enhancement report, ensure the enhancement is reasonable and reasonably simple to implement; instead of asking for an entire UI redo, focus on a specific area that needs work. ++ Ensure the enhancement will fix an issue, such as some settings missing key or accessibility features. ++ Please describe an example of how the enhancement would be implemented and Why It is helpful. ++ Make sure to include the "enhancement" label for the issue. + +It is also important to ensure that an issue is not duplicated or related to another open issue before recording it. + + + +### Extensions: + +**Further details on creating extensions for CloudStream are found on our website. ** + +[Guide: For Extension Developers](https://recloudstream.github.io/csdocs/devs/gettingstarted/) + + + +## Further Sources and Social: + +As well as providing clear install steps, our [website](https://dweb.link/ipns/cloudstream.on.fleek.co/) includes a wide variety of other tools, such as: +- [Troubleshooting](https://recloudstream.github.io/csdocs/troubleshooting/) +- [Further CloudStream Repositories](https://recloudstream.github.io/csdocs/repositories/) +- [Recommened Sources For CloudStream](https://recloudstream.github.io/csdocs/recsrc/) +- [Recommened Apps For CloudStream](https://recloudstream.github.io/csdocs/recapps/) +- Set-Up for other devices, such as: + - [Android Tv](https://recloudstream.github.io/csdocs/other-devices/tv/) + - [Windows](https://recloudstream.github.io/csdocs/other-devices/windows/) + - [Linux](https://recloudstream.github.io/csdocs/other-devices/linux/) +- And more... + +We have a discord server that helps host our passionate community. There, you can hang out and chat with other users of CloudStream, Discuss problems among fellow developers on the project, help with issues, or find guides relating to CloudStream use and development. + +[![Discord](https://invidget.switchblade.xyz/5Hus6fM)](https://discord.gg/5Hus6fM) + + + ### Supported languages: + +Even if you can't contribute to the code or documentation, we always contribute to translation and language support. It's exceptionally appreciated; you can check our translation from the figure below. + Translation status From a2bd2ea08d968a3bf743a76e1777d8e7aebe34bc Mon Sep 17 00:00:00 2001 From: Kai Kitching <144362514+KaiKitKobold@users.noreply.github.com> Date: Thu, 21 Mar 2024 15:25:47 -0700 Subject: [PATCH 2/6] Update README.md This Commit fixes the issue where the about-us could be seen as pro-piracy, it has been changed to a much more descriptive representation of the app. And reinforces our stance against Piracy. --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ca97449d..eaab3768 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,21 @@ ## About us: -**CloudStream is an open-source Android app that streams and downloads movies, TV series, and anime. We provide all of this content ad-free and without subscription or sign-up requirements.** +**CloudStream can be defined in many ways. However, it's best described as a media center that prioritizes and emphasizes complete freedom and total flexibility between users and developers.** + +A more descriptive example of Cloudstream is that it's an extension-based multimedia player with tracking support; an example of extensions for CloudStream includes Support for: + ++ [Librevox (audio-books)](https://librivox.org/) ++ [Youtube](https://www.youtube.com/) ++ [Twitch](https://www.twitch.tv/) ++ [iptv-org (A collection of publicly available IPTV (Internet Protocol television) channels from all over the world.)](https://github.com/iptv-org/iptv) ++ [nginx](https://nginx.org/) ++ And more... + +To reiterate, **we do not support Piracy;** for more details about our stance on the DMCA and EUCD, you can read about it on our Organization: [ReCloudStream](https://github.com/recloudstream) + +**Important Copyright Note:** Our documentation is unmaintained and open to contributions; therefore, apps and sources, extensions in recommended sources, and recommended apps are not officially moderated or endorsed by CloudStream; if you or another copyright owner identify an extension that breaches your copyright, please let us know. + #### Features: + **AdFree**, No ads whatsoever @@ -81,8 +95,6 @@ It is also important to ensure that an issue is not duplicated or related to ano As well as providing clear install steps, our [website](https://dweb.link/ipns/cloudstream.on.fleek.co/) includes a wide variety of other tools, such as: - [Troubleshooting](https://recloudstream.github.io/csdocs/troubleshooting/) - [Further CloudStream Repositories](https://recloudstream.github.io/csdocs/repositories/) -- [Recommened Sources For CloudStream](https://recloudstream.github.io/csdocs/recsrc/) -- [Recommened Apps For CloudStream](https://recloudstream.github.io/csdocs/recapps/) - Set-Up for other devices, such as: - [Android Tv](https://recloudstream.github.io/csdocs/other-devices/tv/) - [Windows](https://recloudstream.github.io/csdocs/other-devices/windows/) From a542efe43beb4d9f0e609306fed1c1222cf3302d Mon Sep 17 00:00:00 2001 From: Kai Kitching <144362514+KaiKitKobold@users.noreply.github.com> Date: Thu, 21 Mar 2024 17:03:41 -0700 Subject: [PATCH 3/6] Update README.md Quick update to READ.ME With changes specified by maintainer @Blatzar --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index eaab3768..9d7de0ab 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ ## Table of Contents: + [About Us:](#about_us) ++ [Discord Server:](#discord) + [Installation Steps:](#install_rules) + [Contributing:](#contributing) + [Issues:](#issues) @@ -11,16 +12,16 @@ + [Enhancement:](#enhancment) + [Extension Development:](#extensions) + [Languauge Support:](#languages) -+ [Further Sources and Social:](#contact_and_sources) ++ [Further Sources](#contact_and_sources) ## About us: -**CloudStream can be defined in many ways. However, it's best described as a media center that prioritizes and emphasizes complete freedom and total flexibility between users and developers.** +**CloudStream is best described as a media center that prioritizes and emphasizes complete freedom and flexibility for users and developers.** -A more descriptive example of Cloudstream is that it's an extension-based multimedia player with tracking support; an example of extensions for CloudStream includes Support for: +CloudStream is an extension-based multimedia player with tracking support. There are extensions to view videos from: + [Librevox (audio-books)](https://librivox.org/) + [Youtube](https://www.youtube.com/) @@ -29,9 +30,12 @@ A more descriptive example of Cloudstream is that it's an extension-based multim + [nginx](https://nginx.org/) + And more... -To reiterate, **we do not support Piracy;** for more details about our stance on the DMCA and EUCD, you can read about it on our Organization: [ReCloudStream](https://github.com/recloudstream) -**Important Copyright Note:** Our documentation is unmaintained and open to contributions; therefore, apps and sources, extensions in recommended sources, and recommended apps are not officially moderated or endorsed by CloudStream; if you or another copyright owner identify an extension that breaches your copyright, please let us know. +**we do not support Piracy.** For more details about our stance on the DMCA and EUCD, you can read about it on our organization: [reCloudStream](https://github.com/recloudstream) + +#### Important Copyright Note: + +Our documentation is unmaintained and open to contributions; therefore, apps and sources, extensions in recommended sources, and recommended apps are not officially moderated or endorsed by CloudStream; if you or another copyright owner identify an extension that breaches your copyright, please let us know. #### Features: @@ -42,6 +46,14 @@ To reiterate, **we do not support Piracy;** for more details about our stance on + Chromecast + Extension system for personal customization + + +### Discord Server: + +We have a discord server that hosts our passionate community, if you wish to talk with the maintainers of this project, have questions relating to CloudStream, or just wish to hang out, then please join our discord server through the link below. + +[![Discord](https://invidget.switchblade.xyz/5Hus6fM)](https://discord.gg/5Hus6fM) + ## Installation: @@ -101,10 +113,6 @@ As well as providing clear install steps, our [website](https://dweb.link/ipns/c - [Linux](https://recloudstream.github.io/csdocs/other-devices/linux/) - And more... -We have a discord server that helps host our passionate community. There, you can hang out and chat with other users of CloudStream, Discuss problems among fellow developers on the project, help with issues, or find guides relating to CloudStream use and development. - -[![Discord](https://invidget.switchblade.xyz/5Hus6fM)](https://discord.gg/5Hus6fM) - ### Supported languages: From f726c1e888aea6324014f3caf2871e05ab6d7f65 Mon Sep 17 00:00:00 2001 From: Kai Kitching <144362514+KaiKitKobold@users.noreply.github.com> Date: Fri, 22 Mar 2024 09:02:44 -0700 Subject: [PATCH 4/6] Update README.md Updated Read.me to include suggestions from both Green and Yapper. Mainly changed wording to be more professional on our stance on piracy and changed the issues tab. --- README.md | 42 ++++++++++++++---------------------------- 1 file changed, 14 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 9d7de0ab..593f6a58 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ ## About us: -**CloudStream is best described as a media center that prioritizes and emphasizes complete freedom and flexibility for users and developers.** +**CloudStream is a media center that prioritizes and emphasizes complete freedom and flexibility for users and developers.** CloudStream is an extension-based multimedia player with tracking support. There are extensions to view videos from: @@ -31,7 +31,7 @@ CloudStream is an extension-based multimedia player with tracking support. There + And more... -**we do not support Piracy.** For more details about our stance on the DMCA and EUCD, you can read about it on our organization: [reCloudStream](https://github.com/recloudstream) +**Please don't create illegal extensions or use any that host any copyrighted media.** For more details about our stance on the DMCA and EUCD, you can read about it on our organization: [reCloudStream](https://github.com/recloudstream) #### Important Copyright Note: @@ -50,7 +50,7 @@ Our documentation is unmaintained and open to contributions; therefore, apps and ### Discord Server: -We have a discord server that hosts our passionate community, if you wish to talk with the maintainers of this project, have questions relating to CloudStream, or just wish to hang out, then please join our discord server through the link below. +We have a Discord server that hosts our passionate community; if you wish to talk with the project's maintainers, have questions about CloudStream, or just hang out, please join our Discord server through the link below. [![Discord](https://invidget.switchblade.xyz/5Hus6fM)](https://discord.gg/5Hus6fM) @@ -66,37 +66,23 @@ Our documentation provides the steps to Install Cloudstream. The steps are simpl ## Contributing: We **happily** accept any contributions to our project. To find out where you can start contributing towards the project, please look [at our issues tab](/cloudstream/issues) -While we do not have intensive syntax rules for pull requests, it's appreciated that you follow the following rules when creating an issue: + + ### Issues: -While we **actively** accept issues and pull requests, we do not have any syntaxial rules; for issue contributions, however, it is heavily appreciated if your issue includes the following: +While we **actively** accept issues and pull requests; We do require you fill out an [template](https://github.com/recloudstream/cloudstream/issues/new/choose) for issues, these include the following: +- [Bug Report Template: ](https://github.com/recloudstream/cloudstream/issues/new?assignees=&labels=bug&projects=&template=application-bug.yml) + - For bug reports, we want as much info as possible, including your downloaded version of CloudeStream, device and updated version (if possible, current API), + expected behavior of the program, and the actual behavior that the program did, most importantly we require clear, reproducible steps of the bug. If your bug can't be reproduced, it is unlikely we'll work on your issue. +- [Feature Request Template: ](https://github.com/recloudstream/cloudstream/issues/new?assignees=&labels=enhancement&projects=&template=feature-request.yml) + - Before adding a feature request, please check to see if a feature request already has been requested. - - -#### Bug Reports: -+ A Short but Descriptive Title that accurately describes the bug and the issue. -+ Steps to reproduce: Make sure that the bug is reproducible And describe the steps in brief but descriptive steps -+ Make sure you include the version and the commit hash of the version of CloudStream that the bug appeared in -+ Make sure you include a description of the expected behavior of the program and the actual behavior of the bug -+ Make sure to include the "bug" label for the issue - - - -#### Enhancement: -+ Before you add your Enhancement report, ensure the enhancement is reasonable and reasonably simple to implement; instead of asking for an entire UI redo, focus on a specific area that needs work. -+ Ensure the enhancement will fix an issue, such as some settings missing key or accessibility features. -+ Please describe an example of how the enhancement would be implemented and Why It is helpful. -+ Make sure to include the "enhancement" label for the issue. - -It is also important to ensure that an issue is not duplicated or related to another open issue before recording it. - - ### Extensions: -**Further details on creating extensions for CloudStream are found on our website. ** +**Further details on creating extensions for CloudStream are found in our documentation. ** [Guide: For Extension Developers](https://recloudstream.github.io/csdocs/devs/gettingstarted/) @@ -108,7 +94,7 @@ As well as providing clear install steps, our [website](https://dweb.link/ipns/c - [Troubleshooting](https://recloudstream.github.io/csdocs/troubleshooting/) - [Further CloudStream Repositories](https://recloudstream.github.io/csdocs/repositories/) - Set-Up for other devices, such as: - - [Android Tv](https://recloudstream.github.io/csdocs/other-devices/tv/) + - [Android TV](https://recloudstream.github.io/csdocs/other-devices/tv/) - [Windows](https://recloudstream.github.io/csdocs/other-devices/windows/) - [Linux](https://recloudstream.github.io/csdocs/other-devices/linux/) - And more... @@ -117,7 +103,7 @@ As well as providing clear install steps, our [website](https://dweb.link/ipns/c ### Supported languages: -Even if you can't contribute to the code or documentation, we always contribute to translation and language support. It's exceptionally appreciated; you can check our translation from the figure below. +Even if you can't contribute to the code or documentation, we always look for those who can contribute to translation and language support. Your contribution is exceptionally appreciated; you can check our translation from the figure below. Translation status From 45b6a8d60d84e5d51d7e7c6e6cfc985bcd9f7e8a Mon Sep 17 00:00:00 2001 From: Kai Kitching <144362514+KaiKitKobold@users.noreply.github.com> Date: Fri, 22 Mar 2024 09:04:49 -0700 Subject: [PATCH 5/6] Update README.md Fixed broken links for #Enhancment, and #Bug Reports. --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 593f6a58..b170be37 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ + [Installation Steps:](#install_rules) + [Contributing:](#contributing) + [Issues:](#issues) - + [Bugs:](#bug_report) + + [Bugs Reports:](#bug_report) + [Enhancement:](#enhancment) + [Extension Development:](#extensions) + [Languauge Support:](#languages) @@ -73,9 +73,15 @@ We **happily** accept any contributions to our project. To find out where you ca ### Issues: While we **actively** accept issues and pull requests; We do require you fill out an [template](https://github.com/recloudstream/cloudstream/issues/new/choose) for issues, these include the following: + + + - [Bug Report Template: ](https://github.com/recloudstream/cloudstream/issues/new?assignees=&labels=bug&projects=&template=application-bug.yml) - For bug reports, we want as much info as possible, including your downloaded version of CloudeStream, device and updated version (if possible, current API), - expected behavior of the program, and the actual behavior that the program did, most importantly we require clear, reproducible steps of the bug. If your bug can't be reproduced, it is unlikely we'll work on your issue. + expected behavior of the program, and the actual behavior that the program did, most importantly we require clear, reproducible steps of the bug. If your bug can't be reproduced, it is unlikely we'll work on your issue. + + + - [Feature Request Template: ](https://github.com/recloudstream/cloudstream/issues/new?assignees=&labels=enhancement&projects=&template=feature-request.yml) - Before adding a feature request, please check to see if a feature request already has been requested. From 8dde852dfc2a892feb5280d6fbfc89d2713aefb4 Mon Sep 17 00:00:00 2001 From: Kai Kitching <144362514+KaiKitKobold@users.noreply.github.com> Date: Fri, 22 Mar 2024 14:13:04 -0700 Subject: [PATCH 6/6] Update README.md Removed Social in the Further Sources, since it doesn't host the discord server link anymore --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b170be37..8fdec41d 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ While we **actively** accept issues and pull requests; We do require you fill ou -## Further Sources and Social: +## Further Sources: As well as providing clear install steps, our [website](https://dweb.link/ipns/cloudstream.on.fleek.co/) includes a wide variety of other tools, such as: - [Troubleshooting](https://recloudstream.github.io/csdocs/troubleshooting/)