From 0d676c18090890463ce2955e5db77d92250bb595 Mon Sep 17 00:00:00 2001
From: FireMaskterK <20838718+FireMasterK@users.noreply.github.com>
Date: Tue, 9 Nov 2021 17:56:50 +0000
Subject: [PATCH] readme: overhaul and restructure.
---
README.md | 118 ++++++++++++++++++++++++++++++++----------------------
1 file changed, 71 insertions(+), 47 deletions(-)
diff --git a/README.md b/README.md
index f492ca41..fbfca161 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,13 @@
# Piped
+[](https://www.gnu.org/licenses/agpl-3.0.en.html)
[](https://matrix.to/#/#piped:matrix.org)
[](https://piped-ipfs.kavin.rocks/)
[](https://github.com/TeamPiped/Piped/stargazers)
[](https://github.com/TeamPiped/Piped/commits)
[](https://hosted.weblate.org/projects/piped/frontend/)
-An alternative YouTube frontend which is efficient by design.
+An open-source alternative frontend for YouTube which is efficient by design.
# The Problem
@@ -16,45 +17,95 @@ By using Piped, you can freely watch and listen to content freely without the fe
## Features:
+**User Features**
+
- [x] No Ads
- [x] No Tracking
+- [x] Lightweight on server and client
- [x] Infinite Scrolling
+- [x] Light/Dark themes
- [x] Login
- [x] Feeds
- [x] Integration with SponsorBlock
-- [x] Integration with LBRY
+- [x] Integration with [LBRY](https://lbry.com/) for streaming
- [x] 4K support
- [x] No connections to Google's servers
- [x] Playing just audio
-- [x] Comments
-- [x] Playlist support
-- [x] Captions support
-- [x] Search Suggestions
-- [x] Livestreams support with a quality selector
- [x] PWA support
- [x] Support for IOS
-- [x] Preferences saved locally
-- [x] Multi-region loadbalancing
+- [x] Locally saved Preferences
+- [x] [Available in many languages](src/locales), thanks to [our translators](https://hosted.weblate.org/projects/piped/frontend/)
+- [x] Embedded video support
+
+**Technical Features**
+
+- [x] Multi-region load-balancing
- [x] Performant by design, designed to handle 1000s of users concurrently
+- [x] Does not use official YouTube APIs
+- [x] Uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to extract information
+- [x] Public [JSON API](https://piped-docs.kavin.rocks/docs/api-documentation/)
-## WIP
+## Screenshots
-- [ ] 8K support
-- [ ] Improving UI
+| Player | Trending | Channel |
+| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+|  |  |  |
+
+## Public Chat Rooms
+
+- You can join us via Matrix at [#piped](https://matrix.to/#/#piped:matrix.org).
+- You can also join us at the libera.chat IRC network which is bridged to the Matrix room at [#piped](https://web.libera.chat/#piped).
## Self-Hosting
See https://piped-docs.kavin.rocks/docs/self-hosting/ for more details.
+The source code of the documentation website is available at https://github.com/TeamPiped/Documentation.
+
## Documentation
-The documentation can be found at https://piped-docs.kavin.rocks (accessible via IPNS as well)
+The documentation can be found at https://piped-docs.kavin.rocks (accessible via IPNS as well).
-## Screenshots
+## Extensions
-
-
-
+To redirect all YouTube links to Piped, you are highly recommended to use either [Piped-Redirects](https://github.com/TeamPiped/Piped-Redirects) or Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect#get).
+
+## Contributing
+
+### Translations
+
+You can help by translating the project to a language you speak at https://hosted.weblate.org/projects/piped/frontend/
+
+### Forking, and contributing
+
+- Fork the repository on GitHub: https://github.com/TeamPiped/Piped/fork
+- Create your feature branch: `git checkout -b my-awesome-feature`
+- Stage your files `git add .`
+- Commit your changes `git commit -am 'Add awesome new feature'`
+- Push to the branch `git push origin my-awesome-feature`
+- Create a new pull request: https://github.com/TeamPiped/Piped-Redirects/compare
+
+### Development Setup
+
+```
+yarn install
+```
+
+### Compiles and hot-reloads for development
+
+```
+yarn serve
+```
+
+You can now make changes and view then in realtime!
+
+## Contact
+
+If you would like to contact me personally, you may do so with the following means:
+
+- Matrix: @kavin1337:matrix.org
+- Mastodon: https://mastodon.online/@kavin
+- Email: kavin@kavin.rocks
## Donations
@@ -68,40 +119,13 @@ Donations can be made at:
Contributions in any other form are also welcomed.
-## Development Setup
-
-```
-yarn install
-```
-
-### Compiles and hot-reloads for development
-
-```
-yarn serve
-```
-
-You can now make changes and see them as soon you save the file!
-
-## Contact
-
-If you would like to contact me personally, you may do so with the following means:
-
-- Matrix: @kavin1337:matrix.org
-- Mastodon: https://mastodon.online/@kavin
-- Email: kavin@kavin.rocks
-
-## Public Chat Rooms
-
-- You can join us via Matrix at [#piped](https://matrix.to/#/#piped:matrix.org).
-- You can also join us at the libera.chat IRC network which is bridged to the Matrix room at [#piped](https://web.libera.chat/#piped).
-
## YourKit
-
+
YourKit has given an open source license for their profiler, greatly simplifying the profiling of Piped's performance.
YourKit supports open source projects with its full-featured Java Profiler.
-YourKit, LLC is the creator of YourKit Java Profiler
-and YourKit .NET Profiler,
+YourKit, LLC is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/)
+and [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/),
innovative and intelligent tools for profiling Java and .NET applications.