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).