add README.md

This commit is contained in:
Yasuhiro Matsumoto 2017-04-13 16:48:45 +09:00
parent cf8a9bad6d
commit 2534bf761c

35
README.md Normal file
View File

@ -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)