From 1c2f03e0a7c2dc62f5a490b71d3576d47d1ef800 Mon Sep 17 00:00:00 2001 From: Zed Date: Fri, 21 Jun 2019 20:36:00 +0200 Subject: [PATCH] Update readme --- README.md | 8 ++++++-- nitter.nimble | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cfd50d0..1b5b046 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Inspired by the [invidio.us](https://github.com/omarroth/invidious) project. - Prevents Twitter from tracking your IP or JavaScript fingerprint - Unofficial API (no rate limits or developer account required) - Lightweight (for [@nim_lang](https://twitter.com/nim_lang), 32KB vs 552KB from twitter.com) +- AGPLv3 licensed, no proprietary instances allowed - Dark theme ## Installation @@ -17,18 +18,21 @@ cd nitter nimble build ``` -To run, `./src/nitter` +To run, `./nitter` ## Todo - Simple account system with feed (excludes retweets) - Hiding retweets from timelines - Video support with hls.js -- "Cards" (link previews) +- Twitter "Cards" (link previews) +- Nitter link preview - Server config - File caching - Themes - Search - Json API +- Emojis +- Nitter logo ## 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. diff --git a/nitter.nimble b/nitter.nimble index 6ec42c4..0feaf8c 100644 --- a/nitter.nimble +++ b/nitter.nimble @@ -11,4 +11,4 @@ bin = @["nitter"] # Dependencies requires "nim >= 0.19.9" -requires "regex", "nimquery", "nimcrypto", "norm", "jester" +requires "regex", "nimcrypto", "norm", "jester", "nimquery#head"