From 83b9bfe6532579198378ee767db0852781050ff3 Mon Sep 17 00:00:00 2001
From: Vidhu Kant Sharma <vidhukant@protonmail.ch>
Date: Sun, 12 Jun 2022 03:24:14 +0530
Subject: first commit

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2735d1a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# macli
+Unofficial CLI-Based MyAnimeList Client
+
+## How to use
+Currently, macli is heavily under development so there are no pre-built binaries available.
+
+### To compile macli, 
+
+1. Clone this repo
+2. Create a .env file with the following data:
+```
+ACCESS_TOKEN={your token here}
+```
+(a token can be generated easily with [this python script.](https://github.com/MikunoNaka/mal-authtoken-generator))
+3. Run macli with `./macli`
+
+NOTE: currently, it looks for the .env file in the PWD, but a token can also be passed with
+``` shell
+export ACCESS_TOKEN={your token here}
+```
+for use inside other directories. (this way of handling the token is going to change)
+
+## Licence
+Licenced under GNU General Public Licence V3
+
+GNU GPL License: [LICENSE](LICENSE)
+
+Copyright (c) 2022 Vidhu Kant Sharma
-- 
cgit v1.2.3