FreeTube/README.md

73 lines
3.6 KiB
Markdown
Raw Normal View History

2018-05-18 02:29:02 +02:00
<p align="center">
<img src="https://freetubeapp.github.io/images/logoColor.png" width=500 align="center">
2018-05-18 02:29:02 +02:00
</p>
2018-03-11 19:14:36 +01:00
FreeTube is an open source desktop YouTube player built with privacy in mind.
2018-06-02 17:22:00 +02:00
Use YouTube without advertisments and prevent Google tracking from you with their cookies and JavaScript.
2018-03-11 19:14:36 +01:00
Available for Windows, Mac & Linux thanks to Electron.
Please note that FreeTube is currently in Beta. While it should work well for
most users, there are still bugs and missing features that need to be
addressed.
2018-06-11 04:49:33 +02:00
[Download FreeTube](https://github.com/FreeTubeApp/FreeTube/releases)
### Browser Extension
Download our browser extension so that you can click on videos in your browser and have them automatically open up in FreeTube.
[Download for Firefox](https://addons.mozilla.org/en-US/firefox/addon/freetube-redirect/)
[Instructrions for Google Chrome](https://github.com/FreeTubeApp/FreeTube/wiki/Browser-Extension)
2018-03-11 19:14:36 +01:00
## How does it work?
FreeTube uses the proprietary [YouTube HTTP
API](https://developers.google.com/youtube/v3/getting-started) with a set of
2018-03-12 02:22:55 +01:00
hard coded API keys. Videos are resolved using
[youtube-dl](https://rg3.github.io/youtube-dl/)
and played using the stock HTML5 video
2018-03-11 19:14:36 +01:00
player. While YouTube can still see your API and video requests it can no
longer track you using cookies or JavaScript. Your subscriptions, history, and
2018-06-02 17:22:00 +02:00
saved videos are stored locally on your computer and never sent out. Using a VPN or Tor is recommended
to hide your IP while using FreeTube.
2018-03-01 04:28:32 +01:00
## Screenshots
2018-03-11 19:14:36 +01:00
<img src="https://freetubeapp.github.io/images/FreeTube1.png" width=200> <img src="https://freetubeapp.github.io/images/FreeTube2.png" width=200> <img src="https://freetubeapp.github.io/images/FreeTube3.png" width=200> <img src="https://freetubeapp.github.io/images/FreeTube5.png" width=200>
2018-03-01 04:28:32 +01:00
## Features
2018-03-11 19:14:36 +01:00
* Watch videos without ads
* Use YouTube without Google tracking you using cookies and JavaScript
2018-06-02 17:22:00 +02:00
* Make API calls through the Tor network
2018-03-01 04:28:32 +01:00
* Subscribe to channels without an account
2018-03-11 19:14:36 +01:00
* Local subscriptions, history, and saved videos
* Export & import subscriptions
2018-06-11 04:49:33 +02:00
* Open videos from your browser directly into FreeTube (with extension)
2018-03-01 04:28:32 +01:00
* Mini Player
2018-03-11 19:14:36 +01:00
* Light / dark theme
2018-03-01 04:28:32 +01:00
2018-03-11 19:14:36 +01:00
## Contributing
If you have an idea or if you found a bug, please submit a GitHub issue so that
we can track it. Please search the existing issues before submitting to
prevent duplicates.
2018-03-01 04:28:32 +01:00
2018-03-11 19:14:36 +01:00
If you like to get your hands dirty and want to contribute, we would love to
have your help. Send a pull request and someone will review your code. Please
follow the [Contribution
Guidelines](https://github.com/FreeTubeApp/FreeTube/blob/master/CONTRIBUTING.md)
before sending your pull request.
2018-03-01 04:28:32 +01:00
2018-06-02 17:22:00 +02:00
Thank you very much to the [People and Projects](https://github.com/FreeTubeApp/FreeTube/wiki/Credits) that make FreeTube possible!
2018-06-17 01:05:00 +02:00
## Contact
If you ever have any questions, feel free to make an issue here on GitHub. Alternatively, you can email me at FreeTubeApp@protonmail.com or you can join our [Matrix Server](https://riot.im/app/#/room/#freetube:matrix.org). Don't forget to check out the [rules](https://github.com/FreeTubeApp/FreeTube/wiki/Matrix-Server-Info-&-Rules) before joining.
2018-03-11 19:14:36 +01:00
## License
2018-03-01 04:28:32 +01:00
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)
FreeTube is Free Software: You can use, study share and improve it at your
will. Specifically you can redistribute and/or modify it under the terms of the
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.