aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 3d231a022f55f012e97dc71213fe9f25443661e8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 📰 `suzuri`

Command-line Interface to sumi.news

Who is Suzuri? Sumi Sakurasawa's dog.

## Usage

Obtain your sumi.news token via the `s` cookie on sumi.news.

### `--help`

```text
usage: sumi [token] [folder]

```

Optionally, omit the token and folder arguments and export the environment
variables `SUZURI_TOKEN` and `SUZURI_FOLDER`.

### Dependencies

- [curl](https://curl.se/)
- [pup](https://github.com/ericchiang/pup)
- [html2md](https://github.com/suntong/html2md)
- [glow](https://github.com/charmbracelet/glow)

## Licence

This project is licensed with the [GNU General Public License v3.0](LICENSE).