recloudstream/cloudstream
3
3
Fork 1
mirror of https://github.com/recloudstream/cloudstream.git synced 2024-08-15 01:53:11 +00:00
Code Issues Releases Wiki Activity
cloudstream/README.md
Kai Kitching a2bd2ea08d
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.
2024-03-21 15:25:47 -07:00

5.5 KiB
Raw Blame History

CloudStream

⚠️ 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:

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:

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

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

Installation:

Our documentation provides the steps to Install Cloudstream. The steps are simple and extensively customizable for your streaming needs!

Getting Started With CloudStream:

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 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

Further Sources and Social:

As well as providing clear install steps, our website includes a wide variety of other tools, such as:

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

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