aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index 78e18a5..7b6ab45 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,19 @@
# macli
-Unofficial CLI-Based MyAnimeList Client
-### Notice:
-macli is currently highly under development, so many obvious features may not be present.
+Unofficial CLI-Based MyAnimeList Client
## How to install
+
+If you use an Arch-based distro and too lazy to set up your $GOPATH you can use the AUR package `macli-git`
+
If you have go installed on your system, simply run `go install github.com/MikunoNaka/macli@latest`
+(Make sure you have your $GOPATH set up properly if you have issues running `macli` globally)
-Make sure you have your $GOPATH set up properly if you have issues running `macli` globally
+You can also check out the releases for pre-built binaries. [latest release](/MikunoNaka/macli/releases/latest)
-If you use an Arch-based distro and too lazy to set up your $GOPATH you can use the AUR package `macli-git` but I won't guarantee that it would build without any problems.
+## How to use
-Visit the [macli](https://www.vidhukant.xyz/projects/macli) page on my website for more info.
+Run `macli --help` for instructions
## Licence
Licenced under GNU General Public Licence V3