golang/mikael/madon: README.md@70aadba26338 (annotated)

137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	1	# madon
2 10ffb25f0ca2 Basic README. Ollivier Robert <roberto@keltia.net> parents: 0 diff changeset	2
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	3	Golang library for the Mastodon API
2 10ffb25f0ca2 Basic README. Ollivier Robert <roberto@keltia.net> parents: 0 diff changeset	4
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	5	[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/McKael/madon)
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	6	[![license](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/McKael/madon/master/LICENSE)
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	7	[![build](https://img.shields.io/travis/McKael/madon.svg?style=flat)](https://travis-ci.org/McKael/madon)
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	8	[![Go Report Card](https://goreportcard.com/badge/github.com/McKael/madon)](https://goreportcard.com/report/github.com/McKael/madon)
2 10ffb25f0ca2 Basic README. Ollivier Robert <roberto@keltia.net> parents: 0 diff changeset	9
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	10	`madon` is a [Go](https://golang.org/) library to access the Mastondon REST API.
2 10ffb25f0ca2 Basic README. Ollivier Robert <roberto@keltia.net> parents: 0 diff changeset	11
144 9298c19a2b06 Update README Mikael Berthe <mikael@lilotux.net> parents: 141 diff changeset	12	This implementation covers 100% of the current API, including the streaming API.
9298c19a2b06 Update README Mikael Berthe <mikael@lilotux.net> parents: 141 diff changeset	13
9298c19a2b06 Update README Mikael Berthe <mikael@lilotux.net> parents: 141 diff changeset	14	The [madonctl](https://github.com/McKael/madonctl) console client uses this library exhaustively.
9298c19a2b06 Update README Mikael Berthe <mikael@lilotux.net> parents: 141 diff changeset	15
2 10ffb25f0ca2 Basic README. Ollivier Robert <roberto@keltia.net> parents: 0 diff changeset	16	## Installation
10ffb25f0ca2 Basic README. Ollivier Robert <roberto@keltia.net> parents: 0 diff changeset	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 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	19
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	20	go get github.com/McKael/madon
2 10ffb25f0ca2 Basic README. Ollivier Robert <roberto@keltia.net> parents: 0 diff changeset	21
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	22	You can test it with my CLI tool:
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	23
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	24	go get github.com/McKael/madonctl
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	25
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	26	## Usage
2 10ffb25f0ca2 Basic README. Ollivier Robert <roberto@keltia.net> parents: 0 diff changeset	27
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	28	This section has not been written yet (PR welcome).
3 c62478adcd24 Explain gondole. Ollivier Robert <roberto@keltia.net> parents: 2 diff changeset	29
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	30	For now please check [godoc](https://godoc.org/github.com/McKael/madon) and
141 6068de3675c8 README: Fix link URL Mikael Berthe <mikael@lilotux.net> parents: 139 diff changeset	31	check the [madonctl](https://github.com/McKael/madonctl) project
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	32	implementation.
32 c28f7e417146 Point to configuration files. Ollivier Robert <roberto@keltia.net> parents: 11 diff changeset	33
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	34	## History
32 c28f7e417146 Point to configuration files. Ollivier Robert <roberto@keltia.net> parents: 11 diff changeset	35
139 7145e95b4f57 Update README Mikael Berthe <mikael@lilotux.net> parents: 137 diff changeset	36	This API implementation was initially submitted as a PR for gondole.
3 c62478adcd24 Explain gondole. Ollivier Robert <roberto@keltia.net> parents: 2 diff changeset	37
139 7145e95b4f57 Update README Mikael Berthe <mikael@lilotux.net> parents: 137 diff changeset	38	The repository is actually a fork of my gondole branch so that
7145e95b4f57 Update README Mikael Berthe <mikael@lilotux.net> parents: 137 diff changeset	39	history and credits are preserved.
3 c62478adcd24 Explain gondole. Ollivier Robert <roberto@keltia.net> parents: 2 diff changeset	40
6 47035af1f167 Add references to docs. Ollivier Robert <roberto@keltia.net> parents: 3 diff changeset	41	## References
47035af1f167 Add references to docs. Ollivier Robert <roberto@keltia.net> parents: 3 diff changeset	42
144 9298c19a2b06 Update README Mikael Berthe <mikael@lilotux.net> parents: 141 diff changeset	43	- [madonctl](https://github.com/McKael/madonctl) (console client based on madon)
137 acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	44	- [Mastodon API documentation](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	45	- [Mastodon Streaming API documentation](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Streaming-API.md)
acaea3179f4d Use my own library name Mikael Berthe <mikael@lilotux.net> parents: 62 diff changeset	46	- [Mastodon repository](https://github.com/tootsuite/mastodon)

author	Mikael Berthe <mikael@lilotux.net>
	Sat, 29 Apr 2017 17:27:15 +0200
changeset 156	70aadba26338
parent 146	e78f5b584c9a
child 224	60b1d842275a
permissions	-rw-r--r--