aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6d87d8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# 🐎 Oguri
+
+> Command-line tool for AniList
+
+Currently, I use it to stay up-to-date with the latest airing schedule, but more subcommands and features will be added as needed.
+
+## `--help`
+
+```
+Usage: oguri [OPTIONS] COMMAND [ARGS]...
+
+ Command-line tool for AniList
+
+Options:
+ --help Show this message and exit.
+
+Commands:
+ schedule (s) Show the airing schedule for a given day or selection
+```
+
+## Licence
+
+This project is licensed under the [GNU General Public License v3.0](./LICENSE.txt).