add README.md

2017-04-13 16:48:45 +09:00 · 2017-04-13 16:48:45 +09:00 · 2534bf761c
commit 2534bf761c
parent cf8a9bad6d
1 changed files with 35 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,35 @@
+# go-mastodon
+
+***EXPERIMENTAL***
+
+## Usage
+
+```go
+c := mastodon.NewClient(&mastodon.Config{
+	Server:       "https://mstdn.jp",
+	ClientID:     "client-id",
+	ClientSecret: "client-secret",
+})
+err := c.Authenticate("your-username", "your-password")
+if err != nil {
+	log.Fatal(err)
+}
+timeline, err := c.GetTimeline("/api/v1/timelines/home")
+if err != nil {
+	log.Fatal(err)
+}
+```
+
+## Installation
+
+```
+$ go get github.com/mattn/go-mastodon
+```
+
+## License
+
+MIT
+
+## Author
+
+Yasuhiro Matsumoto (a.k.a. mattn)