aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: c4a9ba2502f95f7e2afdd7cd8e8c992731d52a52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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 "~/.keep/keep.json")
```