author | Mikael Berthe <mikael@lilotux.net> |
Sun, 16 Feb 2020 18:48:57 +0100 | |
changeset 254 | 0362ce76324f |
parent 246 | 3dcfc59d90b9 |
child 258 | 8f19923fa340 |
permissions | -rw-r--r-- |
137 | 1 |
# madon |
2 | 2 |
|
137 | 3 |
Golang library for the Mastodon API |
2 | 4 |
|
137 | 5 |
[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/McKael/madon) |
6 |
[![license](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/McKael/madon/master/LICENSE) |
|
224
60b1d842275a
README: Fix Travis badge
Mikael Berthe <mikael@lilotux.net>
parents:
146
diff
changeset
|
7 |
[![build](https://travis-ci.org/McKael/madon.svg?branch=master)](https://travis-ci.org/McKael/madon) |
137 | 8 |
[![Go Report Card](https://goreportcard.com/badge/github.com/McKael/madon)](https://goreportcard.com/report/github.com/McKael/madon) |
2 | 9 |
|
137 | 10 |
`madon` is a [Go](https://golang.org/) library to access the Mastondon REST API. |
2 | 11 |
|
144 | 12 |
This implementation covers 100% of the current API, including the streaming API. |
13 |
||
14 |
The [madonctl](https://github.com/McKael/madonctl) console client uses this library exhaustively. |
|
15 |
||
2 | 16 |
## Installation |
17 |
||
146
e78f5b584c9a
Add a note about required Go version
Mikael Berthe <mikael@lilotux.net>
parents:
144
diff
changeset
|
18 |
To install the library (Go >= v1.5 required): |
137 | 19 |
|
20 |
go get github.com/McKael/madon |
|
2 | 21 |
|
246 | 22 |
For minimal compatibility with Go modules support (in Go v1.11), it is |
23 |
recommended to use Go version 1.9+. |
|
24 |
||
137 | 25 |
You can test it with my CLI tool: |
26 |
||
27 |
go get github.com/McKael/madonctl |
|
28 |
||
29 |
## Usage |
|
2 | 30 |
|
137 | 31 |
This section has not been written yet (PR welcome). |
3 | 32 |
|
137 | 33 |
For now please check [godoc](https://godoc.org/github.com/McKael/madon) and |
141 | 34 |
check the [madonctl](https://github.com/McKael/madonctl) project |
137 | 35 |
implementation. |
32
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
36 |
|
137 | 37 |
## History |
32
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
38 |
|
139 | 39 |
This API implementation was initially submitted as a PR for gondole. |
3 | 40 |
|
139 | 41 |
The repository is actually a fork of my gondole branch so that |
42 |
history and credits are preserved. |
|
3 | 43 |
|
6 | 44 |
## References |
45 |
||
144 | 46 |
- [madonctl](https://github.com/McKael/madonctl) (console client based on madon) |
137 | 47 |
- [Mastodon API documentation](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md) |
48 |
- [Mastodon Streaming API documentation](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Streaming-API.md) |
|
49 |
- [Mastodon repository](https://github.com/tootsuite/mastodon) |