-
Notifications
You must be signed in to change notification settings - Fork 550
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updating ReadMe Documentation: #1004
Open
KaiKitKobold
wants to merge
8
commits into
recloudstream:master
Choose a base branch
from
KaiKitKobold:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
f2579a2
Update README.md
KaiKitKobold 96fa3de
Merge branch 'recloudstream:master' into master
KaiKitKobold a2bd2ea
Update README.md
KaiKitKobold a542efe
Update README.md
KaiKitKobold f726c1e
Update README.md
KaiKitKobold 45b6a8d
Update README.md
KaiKitKobold 8dde852
Update README.md
KaiKitKobold 434cb87
Merge branch 'recloudstream:master' into master
KaiKitKobold File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,19 +1,116 @@ | ||||||
# 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) | ||||||
+ [Discord Server:](#discord) | ||||||
+ [Installation Steps:](#install_rules) | ||||||
+ [Contributing:](#contributing) | ||||||
+ [Issues:](#issues) | ||||||
+ [Bugs Reports:](#bug_report) | ||||||
+ [Enhancement:](#enhancment) | ||||||
+ [Extension Development:](#extensions) | ||||||
+ [Languauge Support:](#languages) | ||||||
+ [Further Sources](#contact_and_sources) | ||||||
|
||||||
[![Discord](https://invidget.switchblade.xyz/5Hus6fM)](https://discord.gg/5Hus6fM) | ||||||
|
||||||
### Features: | ||||||
<a id="about_us"></a> | ||||||
|
||||||
## About us: | ||||||
|
||||||
**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: | ||||||
|
||||||
+ [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... | ||||||
|
||||||
|
||||||
**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: | ||||||
|
||||||
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 | ||||||
+ No tracking/analytics | ||||||
+ Bookmarks | ||||||
+ Phone and TV support | ||||||
+ Chromecast | ||||||
+ Extension system for personal customization | ||||||
|
||||||
<a id="discord"></a> | ||||||
|
||||||
### Discord Server: | ||||||
|
||||||
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) | ||||||
|
||||||
<a id="install_rules"></a> | ||||||
|
||||||
## Installation: | ||||||
|
||||||
Our documentation provides the steps to Install Cloudstream. The steps are simple and extensively customizable for your streaming needs! | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The steps themselves are not customizable
Suggested change
|
||||||
|
||||||
[Getting Started With CloudStream:](https://recloudstream.github.io/csdocs/) | ||||||
|
||||||
<a id="contributing"></a> | ||||||
|
||||||
## 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) | ||||||
|
||||||
|
||||||
|
||||||
<a id="issues"></a> | ||||||
|
||||||
### 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: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would change punctuation:
Suggested change
|
||||||
|
||||||
<a id="bug_report"></a> | ||||||
|
||||||
- [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. | ||||||
|
||||||
<a id="#enhancment"> | ||||||
|
||||||
- [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. | ||||||
|
||||||
|
||||||
### Extensions: | ||||||
|
||||||
**Further details on creating extensions for CloudStream are found in our documentation. ** | ||||||
|
||||||
[Guide: For Extension Developers](https://recloudstream.github.io/csdocs/devs/gettingstarted/) | ||||||
|
||||||
<a id="contact_and_sources"></a> | ||||||
|
||||||
## 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/) | ||||||
- [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/) | ||||||
- [Windows](https://recloudstream.github.io/csdocs/other-devices/windows/) | ||||||
- [Linux](https://recloudstream.github.io/csdocs/other-devices/linux/) | ||||||
- And more... | ||||||
|
||||||
<a id="languages"> </a> | ||||||
|
||||||
### Supported languages: | ||||||
|
||||||
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. | ||||||
|
||||||
<a href="https://hosted.weblate.org/engage/cloudstream/"> | ||||||
<img src="https://hosted.weblate.org/widgets/cloudstream/-/app/multi-auto.svg" alt="Translation status" /> | ||||||
</a> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please keep the discord somewhere in the top so people dont miss it 🙏