1 # madon

     2 

     3 Golang library for the Mastodon API

     4 

     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)

     8 

     9 `madon` is a [Go](https://golang.org/) library to access the Mastondon REST API.

    10 

    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 

    15 ## Installation

    16 

    17 To install the library (Go >= v1.5 required):

    18 

    19     go get github.com/McKael/madon

    20 

    21 For minimal compatibility with Go modules support (in Go v1.11), it is

    22 recommended to use Go version 1.9+.

    23 

    24 You can test it with my CLI tool:

    25 

    26     go get github.com/McKael/madonctl

    27 

    28 ## Usage

    29 

    30 This section has not been written yet (PR welcome).

    31 

    32 For now please check [godoc](https://godoc.org/github.com/McKael/madon) and

    33 check the [madonctl](https://github.com/McKael/madonctl) project

    34 implementation.

    35 

    36 ## History

    37 

    38 This API implementation was initially submitted as a PR for gondole.

    39 

    40 The repository is actually a fork of my gondole branch so that

    41 history and credits are preserved.

    42 

    43 ## References

    44 

    45 - [madonctl](https://github.com/McKael/madonctl) (console client based on madon)

    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)