Updating ReadMe Documentation: #1004
Conversation
Committing this will update the Read.Me, Including a table of contents, descriptions of the project, and links to documentation relating to the project.
|
I Will Add that this is a first draft, and I expect this Commit to be flawed Initially anyway; I'll keep iterating until it gets a thumbs up from various Maintainers. |
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.
|
Read.Me has been updated. Please let me know of any potential errors and what needs to be changed or updated. |
|
|
||
| [](https://discord.gg/5Hus6fM) |
There was a problem hiding this comment.
Please keep the discord somewhere in the top so people dont miss it 🙏
README.md
Outdated
|
|
||
| ## 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.** |
There was a problem hiding this comment.
No need for the first sentence
| **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.** |
README.md
Outdated
|
|
||
| **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: |
There was a problem hiding this comment.
| 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: |
README.md
Outdated
| + [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) |
There was a problem hiding this comment.
This is the first iteration
| 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) | |
| **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) |
|
|
||
| ## 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.
The steps themselves are not customizable
| Our documentation provides the steps to Install Cloudstream. The steps are simple and extensively customizable for your streaming needs! | |
| Our documentation provides the steps to install and configure CloudStream for your streaming needs. |
README.md
Outdated
| <a id="issues"></a> | ||
|
|
||
| ### 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: |
There was a problem hiding this comment.
We do have syntaxial rules, by the templates when making issues: https://github.com/recloudstream/cloudstream/issues/new/choose
This section is therefore probably better for linking to the issues, e.g:
https://github.com/recloudstream/cloudstream/issues/new?assignees=&labels=bug&projects=&template=application-bug.yml
And describing that for bug reports we want as much info as possible just to make it possible to replicate the bug in order to fix it.
And for feature requests its very important to check that its not already requested to prevent spam.
README.md
Outdated
|
|
||
| ### Extensions: | ||
|
|
||
| **Further details on creating extensions for CloudStream are found on our website. ** |
There was a problem hiding this comment.
| **Further details on creating extensions for CloudStream are found on our website. ** | |
| **Further details on creating extensions for CloudStream are found on our website.** | |
| If you need help with development please come ask in our discord. |
Quick update to READ.ME With changes specified by maintainer @Blatzar
|
Hello @Blatzar! (I'm Sorry for accidentally deleting one of your suggestions; I didn't know what the Resolve conversation actually did until I pressed it.) |
|
Oh Whoops, It seems that I missed a step, I apologize, I'll get started working on it right away. |
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.
Fixed broken links for #Enhancment, and #Bug Reports.
|
Hello @Blatzar, I've updated the ReadME to include your and Green's suggestions; if you wish for anything in the issues header or anything else in the project to be fixed, please let me know. |
Removed Social in the Further Sources, since it doesn't host the discord server link anymore
|
Any update on this @Blatzar |
|
@Blatzar, I am commenting to let you know that I'm still available and ready to update this project if needed. |
| <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.
I would change punctuation:
| 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: | |
| 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: |
Since the initial Read.me documentation was lacking with helpful sources and information about the project, and sources relating to the project, I've updated the Read.Me, to include other links to the project and sections of content relating to various aspects of the project.
Please let me know if this does not fit expectations; I can easily update it to improve it.