diff --git a/README.md b/README.md index 8dc5e0f5..cfb6515d 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,133 @@ -
+
](screenshots/01_player.png?raw=true) | [
](screenshots/02_preferences.png?raw=true) | [
](screenshots/03_subscriptions.png?raw=true) |
-| [
](screenshots/04_description.png?raw=true) | [
](screenshots/05_preferences.png?raw=true) | [
](screenshots/06_subscriptions.png?raw=true) |
+**Using invidious:**
----
+- [Select a public instance from the list](https://instances.invidious.io) and start watching videos right now!
-## Donate:
+**Hosting invidious:**
-Bitcoin (BTC): [bc1qfhe7rq3lqzuayzjxzyt9waz9ytrs09kla3tsgr](bitcoin:bc1qfhe7rq3lqzuayzjxzyt9waz9ytrs09kla3tsgr)
+- [Follow the installation instructions](https://docs.invidious.io/Installation.md)
-Monero (XMR): [41nMCtek197boJtiUvGnTFYMatrLEpnpkQDmUECqx5Es2uX3sTKKWVhSL76suXsG3LXqkEJBrCZBgPTwJrDp1FrZJfycGPR](monero:41nMCtek197boJtiUvGnTFYMatrLEpnpkQDmUECqx5Es2uX3sTKKWVhSL76suXsG3LXqkEJBrCZBgPTwJrDp1FrZJfycGPR)
----
+## Documentation
-## Documentation:
+The full documentation can be accessed online at https://docs.invidious.io/
-The complete documentation is available on https://docs.invidious.io/ (or alternatively on its own [Github repository](https://github.com/iv-org/documentation)).
+The documentation's source code is available in this repository:
+https://github.com/iv-org/documentation
----
+### Extensions
-## Extensions:
+We highly recommend the use of [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect#get),
+a browser extension that automatically redirects Youtube URLs to any Invidious instance and replaces
+embedded youtube videos on other websites with invidious.
-[Extensions](https://docs.invidious.io/Extensions.md) can be found in the wiki, as well as documentation for integrating it into other projects.
+The documentation contains a list of browser extensions that we recommended to use along with Invidious.
----
+You can read more here: https://docs.invidious.io/Extensions.md
-## Made with Invidious:
+
+## Contribute
+
+### Code
+
+1. Fork it ( https://github.com/iv-org/invidious/fork ).
+1. Create your feature branch (`git checkout -b my-new-feature`).
+1. Stage your files (`git add .`).
+1. Commit your changes (`git commit -am 'Add some feature'`).
+1. Push to the branch (`git push origin my-new-feature`).
+1. Create a new pull request ( https://github.com/iv-org/invidious/compare ).
+
+### Translations
+
+We use [Weblate](https://weblate.org) to manage Invidious translations.
+
+You can suggest new translations and/or correction here: https://hosted.weblate.org/engage/invidious/.
+
+Creating an account is not required, but recommended, especially if you want to contribute regularly.
+Weblate also allows you to log-in with major SSO providers like Github, Gitlab, BitBucket, Google, ...
+
+
+## Projects using Invidious
- [FreeTube](https://github.com/FreeTubeApp/FreeTube): A libre software YouTube app for privacy.
- [CloudTube](https://sr.ht/~cadence/tube/): A JavaScript-rich alternate YouTube player.
@@ -75,33 +135,21 @@ The complete documentation is available on https://docs.invidious.io/ (or altern
- [MusicPiped](https://github.com/deep-gaurav/MusicPiped): A material design music player that streams music from YouTube.
- [HoloPlay](https://github.com/stephane-r/HoloPlay): Funny Android application connecting on Invidious API's with search, playlists and favoris.
----
-## Contributing:
+## Donate
-[](https://github.com/iv-org/invidious/actions) [](https://hosted.weblate.org/engage/invidious/)
+Bitcoin (BTC): [bc1qfhe7rq3lqzuayzjxzyt9waz9ytrs09kla3tsgr](bitcoin:bc1qfhe7rq3lqzuayzjxzyt9waz9ytrs09kla3tsgr)
-1. Fork it ( https://github.com/iv-org/invidious/fork ).
-2. Create your feature branch (git checkout -b my-new-feature).
-3. Commit your changes (git commit -am 'Add some feature').
-4. Push to the branch (git push origin my-new-feature).
-5. Create a new pull request.
+Monero (XMR): [41nMCtek197boJtiUvGnTFYMatrLEpnpkQDmUECqx5Es2uX3sTKKWVhSL76suXsG3LXqkEJBrCZBgPTwJrDp1FrZJfycGPR](monero:41nMCtek197boJtiUvGnTFYMatrLEpnpkQDmUECqx5Es2uX3sTKKWVhSL76suXsG3LXqkEJBrCZBgPTwJrDp1FrZJfycGPR)
-### Translation:
-- Log in with an account you have elsewhere, or register an account and start translating at [Hosted Weblate](https://hosted.weblate.org/engage/invidious/).
+## Liability
----
-
-## Contact:
-
-Feel free to join our [Matrix room](https://matrix.to/#/#invidious:matrix.org).
-
----
-
-## Liability:
-
-We take no responsibility for the use of our tool, or external instances provided by third parties. We strongly recommend you abide by the valid official regulations in your country. Furthermore, we refuse liability for any inappropriate use of Invidious, such as illegal downloading. This tool is provided to you in the spirit of free, open software.
+We take no responsibility for the use of our tool, or external instances
+provided by third parties. We strongly recommend you abide by the valid
+official regulations in your country. Furthermore, we refuse liability
+for any inappropriate use of Invidious, such as illegal downloading.
+This tool is provided to you in the spirit of free, open software.
You may view the LICENSE in which this software is provided to you [here](./LICENSE).
diff --git a/screenshots/02_preferences.png b/screenshots/02_preferences.png
index bca77802..d562100d 100644
Binary files a/screenshots/02_preferences.png and b/screenshots/02_preferences.png differ
diff --git a/screenshots/05_preferences.png b/screenshots/05_preferences.png
index ea7f142f..f1227a66 100644
Binary files a/screenshots/05_preferences.png and b/screenshots/05_preferences.png differ