From da9b15404f9c4aa8305ec429c5d3a745c95c2e24 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Thu, 21 Sep 2023 01:09:14 -0700 Subject: docs(readme): add full information --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d6238b --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# 📰 `suzuri` + +Command-line Interface to sumi.news + +## Usage + +Obtain your sumi.news token via the `s` cookie on sumi.news. + +### `--help` + +``` +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). -- cgit v1.2.3