readme: overhaul and restructure.

README.md

@@ -1,12 +1,13 @@
 # Piped
 
+[![AGPL v3](https://shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)
 [![Matrix](https://img.shields.io/matrix/piped:matrix.org)](https://matrix.to/#/#piped:matrix.org)
 [![IPFS Build](https://github.com/TeamPiped/Piped/actions/workflows/build.yml/badge.svg)](https://piped-ipfs.kavin.rocks/)
 [![GitHub Repo stars](https://img.shields.io/github/stars/TeamPiped/Piped-Frontend?style=social)](https://github.com/TeamPiped/Piped/stargazers)
 [![GitHub last commit](https://img.shields.io/github/last-commit/TeamPiped/Piped-Frontend)](https://github.com/TeamPiped/Piped/commits)
 [![Translation status](https://hosted.weblate.org/widgets/piped/-/frontend/svg-badge.svg)](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] Locally saved Preferences
--   [x] Multi-region loadbalancing
+-   [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
+| Player                                                                                                        | Trending                                                                                                      | Channel                                                                                                       |
--   [ ] Improving UI
+| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| ![Screenshot 1](https://cloudflare-ipfs.com/ipfs/bafybeiaxhsog7jzydr7xb3xhlemxilqksceqg5fraaiuojzclhocsqrcvq) | ![Screenshot 2](https://cloudflare-ipfs.com/ipfs/bafybeigafumvrgbfyufxjptvufobstrywrfv2kteyuuictfko6kvghjszu) | ![Screenshot 3](https://cloudflare-ipfs.com/ipfs/bafybeiehs5xjqmmq34gmewxoqm3j3b2ze3pve4sdmanz7ukrxwgrcmxnry) |
+
+## 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
 
-![Screenshot 1](https://cloudflare-ipfs.com/ipfs/bafybeigafumvrgbfyufxjptvufobstrywrfv2kteyuuictfko6kvghjszu)
+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).
-![Screenshot 2](https://cloudflare-ipfs.com/ipfs/bafybeiaxhsog7jzydr7xb3xhlemxilqksceqg5fraaiuojzclhocsqrcvq)
+
-![Screenshot 3](https://cloudflare-ipfs.com/ipfs/bafybeiehs5xjqmmq34gmewxoqm3j3b2ze3pve4sdmanz7ukrxwgrcmxnry)
+## 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
 
-<img src="https://www.yourkit.com/images/yklogo.png"></img>
+![](https://www.yourkit.com/images/yklogo.png)
 
 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 <a href="https://www.yourkit.com/java/profiler/">YourKit Java Profiler</a>
+YourKit, LLC is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/)
-and <a href="https://www.yourkit.com/.net/profiler/">YourKit .NET Profiler</a>,
+and [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/),
 innovative and intelligent tools for profiling Java and .NET applications.