diff options
| author | Jordan <me@jordan.im> | 2021-12-03 07:19:28 -0700 |
|---|---|---|
| committer | Jordan <me@jordan.im> | 2021-12-03 07:19:28 -0700 |
| commit | b0835fc63877c63e88e75840c5d52d3167ad5e10 (patch) | |
| tree | 9db697711cab98fa9c49f87d40d6f7212baae19c /README.md | |
| download | keep-b0835fc63877c63e88e75840c5d52d3167ad5e10.tar.gz keep-b0835fc63877c63e88e75840c5d52d3167ad5e10.zip | |
initial commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f5046de --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Keep + +Keep is a minimal Discord bot which saves any URLs parsed from messages visible +to the configured account on the Wayback Machine. + +A local cache of saved URLs is kept to prevent duplicate availability API +requests. + +## Installation + +Keep can be compiled with `make` or `go build`, and installed system-wide by +running `make install` with root-level permissions. Tests can be run with `make +test`. + +## Usage + +``` +Usage of ./keep: + -config string + path to configuration file (default "/home/jordan/.keep/keep.json") +``` |