Skip to content

Advertise FT better in README #2677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Changes from 19 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
e7bef21
logical structure
efb4f5ff-1298-471a-8973-3d47447115dc Oct 3, 2022
7240789
swap headings
efb4f5ff-1298-471a-8973-3d47447115dc Oct 3, 2022
c9e6276
remove redundant info
efb4f5ff-1298-471a-8973-3d47447115dc Oct 3, 2022
3c31d76
remove disclaimer
efb4f5ff-1298-471a-8973-3d47447115dc Oct 3, 2022
2d38486
concrete wording
efb4f5ff-1298-471a-8973-3d47447115dc Oct 3, 2022
eb449ea
swap nightly and unofficial
efb4f5ff-1298-471a-8973-3d47447115dc Oct 3, 2022
1e79ad0
smaller header
efb4f5ff-1298-471a-8973-3d47447115dc Oct 3, 2022
3c7f328
redirect users to discussions
efb4f5ff-1298-471a-8973-3d47447115dc Oct 3, 2022
a5c2f8d
list chapters as feature
efb4f5ff-1298-471a-8973-3d47447115dc Oct 4, 2022
2b712d9
update localization image
efb4f5ff-1298-471a-8973-3d47447115dc Oct 4, 2022
0ab37b1
Merge branch 'development' into marketing
efb4f5ff-1298-471a-8973-3d47447115dc Oct 4, 2022
58fb056
added some features
efb4f5ff-1298-471a-8973-3d47447115dc Oct 4, 2022
b54cf60
more features and reordering
efb4f5ff-1298-471a-8973-3d47447115dc Oct 4, 2022
c4046f3
Change wording in features
efb4f5ff-1298-471a-8973-3d47447115dc Oct 5, 2022
62717a1
correction on screenshot feature
efb4f5ff-1298-471a-8973-3d47447115dc Oct 5, 2022
e2344cb
condense show/hide into one
efb4f5ff-1298-471a-8973-3d47447115dc Oct 5, 2022
ee633fe
me -> us
efb4f5ff-1298-471a-8973-3d47447115dc Oct 6, 2022
e92e67f
correction on tor proxy
efb4f5ff-1298-471a-8973-3d47447115dc Oct 6, 2022
ebddd85
family
efb4f5ff-1298-471a-8973-3d47447115dc Oct 6, 2022
cb5e9bf
update proxy feature
efb4f5ff-1298-471a-8973-3d47447115dc Oct 7, 2022
8f28665
clarify extension builds
efb4f5ff-1298-471a-8973-3d47447115dc Oct 7, 2022
e9eec5f
revert previous commit and add statement
efb4f5ff-1298-471a-8973-3d47447115dc Oct 8, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 35 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,63 +6,71 @@ FreeTube is an open source desktop YouTube player built with privacy in mind.
Use YouTube without advertisements and prevent Google from tracking you with their cookies and JavaScript.
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.

<p align="center"><a href="https://github.com/FreeTubeApp/FreeTube/releases">Download FreeTube</a></p>

<hr>
<p align="center"><a href="#browser-extension">Browser Extension</a> &bull; <a href="#how-does-it-work">How does it work?</a> &bull; <a href="#screenshots">Screenshots</a> &bull; <a href="#features">Features</a> &bull; <a href="#download-links">Download Links</a> &bull; <a href="#contributing">Contributing</a> &bull; <a href="#localization">Localization</a> &bull; <a href="#contact">Contact</a> &bull; <a href="#donate">Donate</a> &bull; <a href="#license">License</a></p>
<p align="center"><a href="#screenshots">Screenshots</a> &bull; <a href="#how-does-it-work">How does it work?</a> &bull; <a href="#features">Features</a> &bull; <a href="#download-links">Download Links</a> &bull; <a href="#contributing">Contributing</a> &bull; <a href="#localization">Localization</a> &bull; <a href="#contact">Contact</a> &bull; <a href="#donate">Donate</a> &bull; <a href="#license">License</a></p>
<p align="center"><a href="https://freetubeapp.io/">Website</a> &bull; <a href="https://blog.freetubeapp.io/">Blog</a> &bull; <a href="https://docs.freetubeapp.io/">Documentation</a> &bull; <a href="https://docs.freetubeapp.io/faq/">FAQ</a> &bull; <a href="https://github.com/FreeTubeApp/FreeTube/discussions">Discussions</a></p>
<hr>

## Browser Extension

FreeTube is supported by the [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect) and [LibRedirect](https://github.com/libredirect/libredirect) extensions, which will allow you to open YouTube links into FreeTube. You must enable the option within the advanced settings for it to work.
<b>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. If you have an idea or if you found a bug, please submit a [GitHub issue](https://github.com/FreeTubeApp/FreeTube/issues/new/choose) so that
we can track it. Please search [the existing issues](https://github.com/FreeTubeApp/FreeTube/issues) before submitting to
prevent duplicates!</b>

* Download Privacy Redirect for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/privacy-redirect/) or [Google Chrome](https://chrome.google.com/webstore/detail/privacy-redirect/pmcmeagblkinmogikoikkdjiligflglb).

* Download LibRedirect for [Firefox](https://addons.mozilla.org/firefox/addon/libredirect/) or [Google Chrome](https://github.com/libredirect/libredirect/blob/master/chromium.md).

Disclaimer: Learn more about why a browser extension is bad for your [privacy](https://www.privacyguides.org/desktop-browsers/#additional-resources).

If you have issues with the extension working with FreeTube, please create an issue in this repository instead of the extension repository.
## Screenshots
<img src="https://i.imgur.com/zFgZUUV.png" width=300> <img src="https://i.imgur.com/9evYHgN.png" width=300> <img src="https://i.imgur.com/yT2UzPa.png" width=300> <img src="https://i.imgur.com/47zIEt4.png" width=300> <img src="https://i.imgur.com/hFB2fKC.png" width=300>

## How does it work?
FreeTube uses a built in extractor to grab and serve data / videos. The [Invidious API](https://github.com/iv-org/invidious) can also optionally be used. FreeTube does not use any official APIs to obtain data. While YouTube can still see your video requests, it can no
longer track you using cookies or JavaScript. Your subscriptions and history are stored locally on your computer and never sent out. Using a VPN or Tor is highly recommended
to hide your IP while using FreeTube.

Go to [FreeTube's Documentation](https://docs.freetubeapp.io/) if you'd like to know more about how to operate FreeTube and its features.

## Screenshots
<img src="https://i.imgur.com/zFgZUUV.png" width=300> <img src="https://i.imgur.com/9evYHgN.png" width=300> <img src="https://i.imgur.com/yT2UzPa.png" width=300> <img src="https://i.imgur.com/47zIEt4.png" width=300> <img src="https://i.imgur.com/hFB2fKC.png" width=300>

## Features
* Watch videos without ads
* Use YouTube without Google tracking you using cookies and JavaScript
* Two extractor APIs to choose from (Built in or Invidious)
* Subscribe to channels without an account
* Local subscriptions, history, and saved videos
* Connect to an externally setup tor proxy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe remove "tor" as the proxy doesn't have to be a tor proxy

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion Connect to an externally setup (tor) proxy

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe Connect to an externally setup proxy such as Tor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sound good to me

* View and search your local subscriptions, history, and saved videos
* Organize your subscriptions into "Profiles" to create a more focused feed
* Export & import subscriptions
* Youtube Trending
* Youtube Chapters
* Most popular videos page based on the set Invidious instance
* SponsorBlock
* Open videos from your browser directly into FreeTube (with extension)
* Mini Player
* Watch videos using an external player
* Full Theme support
* Make a screenshot of a video
* Multiple windows
* Mini Player (Picture-in-Picture)
* Keyboard shortcuts
* Option to show only family friendly content
* Show/hide functionality or elements within the app using the distraction free settings

## Download Links
### Browser Extension
FreeTube is supported by the [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect) and [LibRedirect](https://github.com/libredirect/libredirect) extensions, which will allow you to open YouTube links into FreeTube. You must enable the option within the advanced settings of the extension for it to work.

### Official Downloads
* Download Privacy Redirect for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/privacy-redirect/) or [Google Chrome](https://chrome.google.com/webstore/detail/privacy-redirect/pmcmeagblkinmogikoikkdjiligflglb).

* Download LibRedirect for [Firefox](https://addons.mozilla.org/firefox/addon/libredirect/) or [Google Chrome](https://github.com/libredirect/libredirect/blob/master/chromium.md).

If you have issues with the extension working with FreeTube, please create an issue in this repository instead of the extension repository.

## Download Links
### Official Downloads
* [GitHub Releases](https://github.com/FreeTubeApp/FreeTube/releases)

* [FreeTube Website](https://freetubeapp.io/#download)

* Flatpak on Flathub: [Download](https://flathub.org/apps/details/io.freetubeapp.FreeTube) [Source](https://github.com/flathub/io.freetubeapp.FreeTube)

### Unofficial Downloads
#### Automated Builds (Nightly / Weekly)
Builds are automatically created from changes to our development branch via [GitHub Actions](https://github.com/FreeTubeApp/FreeTube/actions?query=workflow%3ABuild).

The first build with a green check mark is the latest build. You will need to have a GitHub account to download these builds.

### Unofficial Downloads
These builds are maintained by the community. While they should be safe, download at your own risk. There may be issues with using these versus the official builds. Any issues specific with these builds should be sent to their respective maintainer.

* Arch User Repository (AUR): [Download](https://aur.archlinux.org/packages/freetube-bin/)
Expand All @@ -77,17 +85,7 @@ These builds are maintained by the community. While they should be safe, downlo

* Windows Package Manager (winget): [Usage](https://docs.microsoft.com/en-us/windows/package-manager/winget/)

### Automated Builds (Nightly / Weekly)

Builds are automatically created from changes to our development branch via [GitHub Actions](https://github.com/FreeTubeApp/FreeTube/actions?query=workflow%3ABuild).

The first build with a green check mark is the latest build. You will need to have a GitHub account to download these builds.

## 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.

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
Expand All @@ -98,18 +96,15 @@ Thank you very much to the [People and Projects](https://docs.freetubeapp.io/cre

## Localization
<a href="https://hosted.weblate.org/engage/free-tube/">
<img src="https://hosted.weblate.org/widgets/free-tube/-/translations/287x66-grey.png" alt="Translation status" />
<img src="https://hosted.weblate.org/widgets/free-tube/-/287x66-grey.png" alt="Translation status" />
</a>

We are actively looking for translations! We use [Weblate](https://hosted.weblate.org/engage/free-tube/) to make it easy for translators to get involved. Click on the badge above to learn how to get involved.

For the Linux Flatpak, the desktop entry comment string can be translated at our [Flatpak repository](https://github.com/flathub/io.freetubeapp.FreeTube/blob/master/io.freetubeapp.FreeTube.desktop).

## Contact

If you ever have any questions, feel free to make an issue here on GitHub. Alternatively, you can email me at [email protected] or you can join our [Matrix Community](https://matrix.to/#/+freetube:matrix.org). Don't forget to check out the [rules](https://docs.freetubeapp.io/community/matrix/) before joining.

You can also stay up to date by reading the [FreeTube Blog](https://write.as/freetube/). [View the welcome blog](https://write.as/freetube/welcome-to-freetube-blogs).
If you ever have any questions, feel free to ask it on our [Discussions](https://github.com/FreeTubeApp/FreeTube/discussions) page. Alternatively, you can email us at [email protected] or you can join our [Matrix Community](https://matrix.to/#/+freetube:matrix.org). Don't forget to check out the [rules](https://docs.freetubeapp.io/community/matrix/) before joining.

## Donate
If you enjoy using FreeTube, you're welcome to leave a donation using the following methods.
Expand Down