aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJordan <me@jordan.im>2021-12-18 16:45:53 -0700
committerJordan <me@jordan.im>2021-12-18 16:45:53 -0700
commit245076d017f26e12c162c08933fa3078cf19f63b (patch)
tree52d39fa92bfb100d9950c817cea6d10158ff119c /README.md
parent27584d82ad625428c0c3f0e9edb48d1f51647ec6 (diff)
downloadkeep-245076d017f26e12c162c08933fa3078cf19f63b.tar.gz
keep-245076d017f26e12c162c08933fa3078cf19f63b.zip
web, db: add processed URL index, housekeeping
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index c4a9ba2..17f19ac 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# Keep
-Keep is a minimal Discord bot which saves any URLs parsed from messages visible
-to the configured account on the Wayback Machine.
+Keep is a minimal Discord bot which archives URLs visible to the configured
+account (sent by anyone, anywhere) on the Wayback Machine.
A local cache of saved URLs is kept to prevent duplicate availability API
requests.
@@ -14,6 +14,9 @@ test`.
## Usage
+Create `~/.keep`, copy and populate `keep.json`, then start `./keep`. An index
+of processed URLs can be found at `127.0.0.1:9099`.
+
```
Usage of ./keep:
-config string