aboutsummaryrefslogtreecommitdiff
path: root/manga/README.md
diff options
context:
space:
mode:
authorVidhu Kant Sharma <vidhukant@protonmail.ch>2022-02-23 20:52:09 +0530
committerVidhu Kant Sharma <vidhukant@protonmail.ch>2022-02-23 20:52:09 +0530
commit5e01fb1297e25314184effe2c9f9fbbda0e512fb (patch)
tree0d4d1b1aedd67a3b660dfb26c8ce407c5367898a /manga/README.md
parent8c685067611d829e5fb8eeaaba48508d15cd4dde (diff)
Pushing barebones manga package
Diffstat (limited to 'manga/README.md')
-rw-r--r--manga/README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/manga/README.md b/manga/README.md
new file mode 100644
index 0000000..74a97a3
--- /dev/null
+++ b/manga/README.md
@@ -0,0 +1,45 @@
+# MAL2Go/manga
+MAL2Go `manga` package has functionality related to getting data about anime.
+
+## Installation
+In a terminal, run
+``` fish
+go get "github.com/MikunoNaka/MAL2Go/manga"
+```
+
+## Usage
+Firstly, import this package and instanciate the client.
+``` go
+import (
+ "github.com/MikunoNaka/MAL2Go/manga"
+)
+```
+
+Now instanciate with
+``` go
+myClient := manga.Client {
+ AuthToken: "Bearer " + yourTokenHere,
+}
+```
+
+- ### Searching for a manga
+``` go
+```
+
+- ### Getting a manga's info
+``` go
+```
+
+- ### Get manga ranking
+``` go
+```
+
+## Structure
+- [manga.go](anime.go)
+Contains all the exported functions for pulling data from the API.
+
+- [manga.structs.go](anime.structs.go)
+Contains all the structs representing a manga entry on MyAnimeList.
+
+- [client.go](client.go)
+The Client for accessing the API with this package.