aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorVidhu Kant Sharma <bokuwakanojogahoshii@yahoo.com>2022-02-23 16:25:37 +0000
committerGitHub <noreply@github.com>2022-02-23 16:25:37 +0000
commit678b73e8a648f387339d0e23e2837a0cd493946f (patch)
tree6b42da2083f445e29538c94eb5dcba2ba322a2e7 /README.md
parentb25ce0be1e3dea89d5bbd8826c487f8d9651f140 (diff)
Added installation instructions in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1f8e2c9..a596ac8 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,16 @@
MyAnimeList V2 API wrapper for GoLang
## Installation
+MAL2Go is divided into multiple packages. Each package needs to be installed manually.
In a terminal, run
+``` fish
+go get github.com/MikunoNaka/MAL2Go/anime
+go get github.com/MikunoNaka/MAL2Go/manga
+go get github.com/MikunoNaka/MAL2Go/user
+go get github.com/MikunoNaka/MAL2Go/user/anime
```
-go get github.com/MikunoNaka/MAL2Go
-```
+To install the packages you'd usually need. To find out more about what each package does, refer to [Package Structure](#Package-Structure)
+
Go needs to be installed and `$GOPATH` should be set up
## Package Structure