From e5dfabfa8ee370cbcda356448d7153d53a59a5cf Mon Sep 17 00:00:00 2001 From: Vidhu Kant Sharma Date: Mon, 5 Sep 2022 21:09:11 +0530 Subject: Update README: add link to documentation website --- README.md | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9e53aa1..7a988a1 100644 --- a/README.md +++ b/README.md @@ -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: ## 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 -- cgit v1.2.3