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 [![build](https://travis-ci.org/McKael/madon.svg?branch=master)](https://travis-ci.org/McKael/madon)

     8 [![Go Report Card](https://goreportcard.com/badge/github.com/McKael/madon)](https://goreportcard.com/report/github.com/McKael/madon)

     9 

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

    11 

    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 

    16 ## Installation

    17 

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

    19 

    20     go get github.com/McKael/madon

    21 

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

    23 recommended to use Go version 1.9+.

    24 

    25 You can test it with my CLI tool:

    26 

    27     go get github.com/McKael/madonctl

    28 

    29 ## Usage

    30 

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

    32 

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

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

    35 implementation.

    36 

    37 ## History

    38 

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

    40 

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

    42 history and credits are preserved.

    43 

    44 ## References

    45 

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

    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)