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 --- user/README.md | 33 --------------------------------- 1 file changed, 33 deletions(-) (limited to 'user/README.md') diff --git a/user/README.md b/user/README.md index 2717835..ba76847 100644 --- a/user/README.md +++ b/user/README.md @@ -1,39 +1,6 @@ # MAL2Go/user MAL2Go `user` package has functionality related to getting data about the authenticated user. -## Usage -Firstly, import this package and instanciate the client. -``` go -import ( - "github.com/MikunoNaka/MAL2Go/v2/user" -) -``` - -Now instanciate with -``` go -myClient := user.Client { - AuthToken: "Bearer " + yourTokenHere, -} -``` - -- ### Get authenticated user's info -``` go -userData := myClient.GetSelfUserInfo() - -fmt.Println(userData.Name, userData.Picture) -``` - -The `User` datatype has the following fields: -- `Id` `int` -- `Name` `string` -- `Picture` `string` -- `Gender` `string` -- `Birthday` `string` -- `Location` `string` -- `JoinedAt` `string` -- `TimeZone` `string` -- `IsSupporter` `bool` - ## Structure - [user.go](user.go) Contains all the exported functions for pulling data from the API. -- cgit v1.2.3