diff --git a/README.md b/README.md index a50441a97..0527e6bd2 100644 --- a/README.md +++ b/README.md @@ -1,166 +1 @@ -
- - -## Screenshots - -| Player | Preferences | Subscriptions | -|-------------------------------------|-------------------------------------|---------------------------------------| -|  |  |  | -|  |  |  | - - -## Features - -**User features** -- Lightweight -- No ads -- No tracking -- No JavaScript required -- Light/Dark themes -- Customizable homepage -- Subscriptions independent from Google -- Notifications for all subscribed channels -- Audio-only mode (with background play on mobile) -- Support for Reddit comments -- [Available in many languages](locales/), thanks to [our translators](#contribute) - -**Data import/export** -- Import subscriptions from YouTube, NewPipe and FreeTube -- Import watch history from YouTube and NewPipe -- Export subscriptions to NewPipe and FreeTube -- Import/Export Invidious user data - -**Technical features** -- Embedded video support -- [Developer API](https://docs.invidious.io/api/) -- Does not use official YouTube APIs -- No Contributor License Agreement (CLA) - - -## Quick start - -**Using Invidious:** - -- [Select a public instance from the list](https://instances.invidious.io) and start watching videos right now! - -**Hosting Invidious:** - -- [Follow the installation instructions](https://docs.invidious.io/installation/) - - -## Documentation - -The full documentation can be accessed online at https://docs.invidious.io/ - -The documentation's source code is available in this repository: -https://github.com/iv-org/documentation - -### 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. - -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/applications/ - - -## 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 -m '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 - -A list of projects and extensions for or utilizing Invidious can be found in the documentation: https://docs.invidious.io/applications/ - -## 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. - -You may view the LICENSE in which this software is provided to you [here](./LICENSE). - -> 16. Limitation of Liability. -> -> IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. +This is a test