vendor/github.com/McKael/madon/v3/README.md
changeset 265 05c40b36d3b2
parent 262 8d3354485fc3
child 268 4dd196a4ee7c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/vendor/github.com/McKael/madon/v3/README.md	Sat Feb 04 12:58:35 2023 +0100
@@ -0,0 +1,48 @@
+# madon
+
+Golang library for the Mastodon API
+
+[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/McKael/madon)
+[![license](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/McKael/madon/master/LICENSE)
+[![Go Report Card](https://goreportcard.com/badge/github.com/McKael/madon)](https://goreportcard.com/report/github.com/McKael/madon)
+
+`madon` is a [Go](https://golang.org/) library to access the Mastondon REST API.
+
+This implementation covers 100% of the current API, including the streaming API.
+
+The [madonctl](https://github.com/McKael/madonctl) console client uses this library exhaustively.
+
+## Installation
+
+To install the library (Go >= v1.5 required):
+
+    go get github.com/McKael/madon
+
+For minimal compatibility with Go modules support (in Go v1.11), it is
+recommended to use Go version 1.9+.
+
+You can test it with my CLI tool:
+
+    go get github.com/McKael/madonctl
+
+## Usage
+
+This section has not been written yet (PR welcome).
+
+For now please check [godoc](https://godoc.org/github.com/McKael/madon) and
+check the [madonctl](https://github.com/McKael/madonctl) project
+implementation.
+
+## History
+
+This API implementation was initially submitted as a PR for gondole.
+
+The repository is actually a fork of my gondole branch so that
+history and credits are preserved.
+
+## References
+
+- [madonctl](https://github.com/McKael/madonctl) (console client based on madon)
+- [Mastodon API documentation](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md)
+- [Mastodon Streaming API documentation](https://github.com/tootsuite/documentation/blob/master/Using-the-API/Streaming-API.md)
+- [Mastodon repository](https://github.com/tootsuite/mastodon)