aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordec05eba <dec05eba@protonmail.com>2020-10-06 10:07:03 +0200
committerdec05eba <dec05eba@protonmail.com>2020-10-06 10:07:03 +0200
commit31e22dc49505ff6f7d856aa353cdd744b357add6 (patch)
tree24bafadbfe69931cc239d7f538b79c17eb87c103 /README.md
parentcc12a7d907a958fa9d646c05c98ac1b2ad7efb72 (diff)
Update readme before refactor
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/README.md b/README.md
index d9cc851..a58669a 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,10 @@
# QuickMedia
-Native clients of websites with fast access to what you want to see, **with TOR support**.
+A dmenu-inspired native client for web services.
Currently supported web services: `youtube`, `nyaa.si`, `manganelo`, `mangatown`, `mangadex`, `4chan`, `matrix` and _others_.\
**Note:** Manganelo doesn't work when used with TOR.\
**Note:** Posting comments on 4chan doesn't work when used with TOR. However browsing works.\
-**Note:** TOR system service needs to be running (`systemctl start tor.service`).\
-**Note:** Image pages that were downloaded without --upscale-images and are cached wont get upscaled when running with `--upscale-images`.\
-**Note:** Matrix and file-manager is early in progress.\
+**Note:** TOR system service needs to be running (`systemctl start tor.service`) when using `--tor` option.\
+**Note:** file-manager is early in progress.\
Config data, including manga progress is stored under `$HOME/.config/quickmedia`.\
Cache is stored under `$HOME/.cache/quickmedia`.
## Usage