Update readme wording
This commit is contained in:
parent
1c2f03e0a7
commit
fa91b0e262
38
README.md
38
README.md
|
@ -8,7 +8,7 @@ Inspired by the [invidio.us](https://github.com/omarroth/invidious) project.
|
||||||
- Prevents Twitter from tracking your IP or JavaScript fingerprint
|
- Prevents Twitter from tracking your IP or JavaScript fingerprint
|
||||||
- Unofficial API (no rate limits or developer account required)
|
- Unofficial API (no rate limits or developer account required)
|
||||||
- Lightweight (for [@nim_lang](https://twitter.com/nim_lang), 32KB vs 552KB from twitter.com)
|
- Lightweight (for [@nim_lang](https://twitter.com/nim_lang), 32KB vs 552KB from twitter.com)
|
||||||
- AGPLv3 licensed, no proprietary instances allowed
|
- AGPLv3 licensed, no proprietary instances permitted
|
||||||
- Dark theme
|
- Dark theme
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
@ -18,24 +18,34 @@ cd nitter
|
||||||
nimble build
|
nimble build
|
||||||
```
|
```
|
||||||
|
|
||||||
To run, `./nitter`
|
To run, `./nitter`. It's currently not possible to change any settings or things
|
||||||
|
like the title, this will change as the project matures a bit. For now the focus
|
||||||
|
is on implementing missing features.
|
||||||
|
|
||||||
## Todo
|
## Todo (roughly in this order)
|
||||||
- Simple account system with feed (excludes retweets)
|
|
||||||
- Hiding retweets from timelines
|
|
||||||
- Video support with hls.js
|
|
||||||
- Twitter "Cards" (link previews)
|
|
||||||
- Nitter link preview
|
|
||||||
- Server config
|
|
||||||
- File caching
|
|
||||||
- Themes
|
|
||||||
- Search
|
- Search
|
||||||
- Json API
|
- Simple account system with feed (excludes retweets)
|
||||||
- Emojis
|
- Twitter "Cards" (link previews)
|
||||||
|
- Nitter link previews
|
||||||
|
- Server configuration
|
||||||
|
- Video support with hls.js
|
||||||
|
- Json API endpoints
|
||||||
|
- Hiding retweets from timelines
|
||||||
|
- Themes
|
||||||
|
- Emoji support
|
||||||
|
- File caching
|
||||||
- Nitter logo
|
- Nitter logo
|
||||||
|
|
||||||
## Why?
|
## Why?
|
||||||
It's basically impossible to use Twitter without JavaScript enabled. If you try, you're redirected to the legacy mobile version which is awful both functionally and aesthetically. For privacy-minded folks, preventing JavaScript analytics and potential IP-based tracking is important, but apart from using the legacy mobile version and a VPN, it's impossible. Using an instance of Nitter (hosted on a VPS for example), you can essentially browse Twitter without JavaScript, while retaining your privacy. In the future a simple account system will be added that lets you follow Twitter users, allowing you to have a clean chronological timeline without needing a Twitter account.
|
It's basically impossible to use Twitter without JavaScript enabled. If you try,
|
||||||
|
you're redirected to the legacy mobile version which is awful both functionally
|
||||||
|
and aesthetically. For privacy-minded folks, preventing JavaScript analytics and
|
||||||
|
potential IP-based tracking is important, but apart from using the legacy mobile
|
||||||
|
version and a VPN, it's impossible. Using an instance of Nitter (hosted on a VPS
|
||||||
|
for example), you can essentially browse Twitter without JavaScript, while
|
||||||
|
retaining your privacy. In the future a simple account system will be added that
|
||||||
|
lets you follow Twitter users, allowing you to have a clean chronological
|
||||||
|
timeline without needing a Twitter account.
|
||||||
|
|
||||||
## Screenshot
|
## Screenshot
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue