Merge pull request #6 from MikunoNaka/manga

Manga package completed

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.