diff options
| author | Vidhu Kant Sharma <vidhukant@vidhukant.xyz> | 2022-09-05 21:09:11 +0530 |
|---|---|---|
| committer | Vidhu Kant Sharma <vidhukant@vidhukant.xyz> | 2022-09-05 21:09:11 +0530 |
| commit | e5dfabfa8ee370cbcda356448d7153d53a59a5cf (patch) | |
| tree | 98aaaebbdcc5fd5c796f2ff402a82997d622845d /README.md | |
| parent | 4dd68495f4d1e993af72d2a47530e85522b43a6e (diff) | |
Update README: add link to documentation website
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 3 insertions, 15 deletions
@@ -1,19 +1,9 @@ # MAL2Go 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/v2/anime -go get github.com/MikunoNaka/MAL2Go/v2/manga -go get github.com/MikunoNaka/MAL2Go/v2/user -go get github.com/MikunoNaka/MAL2Go/v2/user/anime -go get github.com/MikunoNaka/MAL2Go/v2/user/manga -``` -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 +## How to use + +Documentation is on my website: <https://vidhukant.xyz/docs/mal2go/> ## Package Structure [anime](anime) package @@ -54,8 +44,6 @@ way to generate a token is to use [my script](https://github.com/MikunoNaka/mal- Each package has a Client struct that needs an `AuthToken: string` among other (optional) values that don't do anything yet. -**NOTE:** I'm new to OAuth and might make changes to the Client struct in each package. - ## Licence Licenced under GNU General Public Licence |