Major README.md cleaning

Additions:
* Add the invidious logo
* Add Quickstart section
* Add relevant links (instance list, documentation, contribute, donate) directly in the header

Badges:
* Add badges for open issues and PRs
* Add "Awesome Humane Tech" badge, as we're listed there
* Move CI passed/translated badges to the top
* Replace the "license feature" with a proper badge

Major section changes:
* Reword titles
* Rewrite features list
* Promote the screenshots sections. People like screenshots!
* Move "donate" to the end, there is a link at the top anyway
* Move section "made with invidious" after all the other invidious related sections + rename it to "Projects using Invidious"

Other fixes:
* Remove useless HTML in the screenshots table
* Remove extra columns in H2 titles
* Remove all useless lines between sections
* Use markdown for git commands + add the staging step
* Promote invidious redirect in "Extensions"
* Update preference screenshots

2021-07-24 20:48:30 +02:00

6.7 KiB

Raw Blame History

Invidious

An open source alternative front-end to YouTube

Instances list • Documentation • Contribute • Donate

Chat with us:

Screenshots

Player	Preferences	Subscriptions

Features

User features

Lightweight
No ads
No tracking
No JavaScript required
Light/Dark themes
Customizable homepage
Subscriptions independant from Google
Notifications for all subscribed channels
Audio-only mode (with background play on mobile)
Support for Reddit comments
Available in many languages, thanks to our translators

Data import/export

Import subscriptions from YouTube, NewPipe and Freetube
Import watch history from NewPipe
Export subscriptions to NewPipe and Freetube
Import/Export Invidious user data

Technical features

Embedded video support
Developer API
Does not use official YouTube APIs
No Contributor License Agreement (CLA)

Quick start

Using invidious:

Select a public instance from the list and start watching videos right now!

Hosting invidious:

Follow the installation instructions

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, 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/Extensions.md

Contribute

Code

Fork it ( https://github.com/iv-org/invidious/fork ).
Create your feature branch (git checkout -b my-new-feature).
Stage your files (git add .).
Commit your changes (git commit -am 'Add some feature').
Push to the branch (git push origin my-new-feature).
Create a new pull request ( https://github.com/iv-org/invidious/compare ).

Translations

We use Weblate 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: A libre software YouTube app for privacy.
CloudTube: A JavaScript-rich alternate YouTube player.
PeerTubeify: On YouTube, displays a link to the same video on PeerTube, if it exists.
MusicPiped: A material design music player that streams music from YouTube.
HoloPlay: Funny Android application connecting on Invidious API's with search, playlists and favoris.

Donate

Bitcoin (BTC): bc1qfhe7rq3lqzuayzjxzyt9waz9ytrs09kla3tsgr

Monero (XMR): 41nMCtek197boJtiUvGnTFYMatrLEpnpkQDmUECqx5Es2uX3sTKKWVhSL76suXsG3LXqkEJBrCZBgPTwJrDp1FrZJfycGPR

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.

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.

6.7 KiB Raw Blame History