diff options
| author | Fuwn <[email protected]> | 2023-09-21 01:09:14 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-09-21 01:09:14 -0700 |
| commit | da9b15404f9c4aa8305ec429c5d3a745c95c2e24 (patch) | |
| tree | 47dae3e68d9244aa9ab5d9d49e79f211d0f58621 /README.md | |
| parent | feat: initial release (diff) | |
| download | suzuri-da9b15404f9c4aa8305ec429c5d3a745c95c2e24.tar.xz suzuri-da9b15404f9c4aa8305ec429c5d3a745c95c2e24.zip | |
docs(readme): add full information
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
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). |