author | Mikael Berthe <mikael@lilotux.net> |
Thu, 22 Sep 2022 16:27:29 +0200 | |
changeset 259 | f807b8fb46c6 |
parent 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) |
|
7 |
[![Go Report Card](https://goreportcard.com/badge/github.com/McKael/madon)](https://goreportcard.com/report/github.com/McKael/madon) |
|
2 | 8 |
|
137 | 9 |
`madon` is a [Go](https://golang.org/) library to access the Mastondon REST API. |
2 | 10 |
|
144 | 11 |
This implementation covers 100% of the current API, including the streaming API. |
12 |
||
13 |
The [madonctl](https://github.com/McKael/madonctl) console client uses this library exhaustively. |
|
14 |
||
2 | 15 |
## Installation |
16 |
||
146
e78f5b584c9a
Add a note about required Go version
Mikael Berthe <mikael@lilotux.net>
parents:
144
diff
changeset
|
17 |
To install the library (Go >= v1.5 required): |
137 | 18 |
|
19 |
go get github.com/McKael/madon |
|
2 | 20 |
|
246 | 21 |
For minimal compatibility with Go modules support (in Go v1.11), it is |
22 |
recommended to use Go version 1.9+. |
|
23 |
||
137 | 24 |
You can test it with my CLI tool: |
25 |
||
26 |
go get github.com/McKael/madonctl |
|
27 |
||
28 |
## Usage |
|
2 | 29 |
|
137 | 30 |
This section has not been written yet (PR welcome). |
3 | 31 |
|
137 | 32 |
For now please check [godoc](https://godoc.org/github.com/McKael/madon) and |
141 | 33 |
check the [madonctl](https://github.com/McKael/madonctl) project |
137 | 34 |
implementation. |
32
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
35 |
|
137 | 36 |
## History |
32
c28f7e417146
Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents:
11
diff
changeset
|
37 |
|
139 | 38 |
This API implementation was initially submitted as a PR for gondole. |
3 | 39 |
|
139 | 40 |
The repository is actually a fork of my gondole branch so that |
41 |
history and credits are preserved. |
|
3 | 42 |
|
6 | 43 |
## References |
44 |
||
144 | 45 |
- [madonctl](https://github.com/McKael/madonctl) (console client based on madon) |
137 | 46 |
- [Mastodon API documentation](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md) |
47 |
- [Mastodon Streaming API documentation](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Streaming-API.md) |
|
48 |
- [Mastodon repository](https://github.com/tootsuite/mastodon) |