# HG changeset patch
# User Ollivier Robert <roberto@keltia.net>
# Date 1491395672 -7200
# Node ID 10ffb25f0ca2902aca0041a3edfda831c7dfdc15
# Parent  00a8d005bc21bbf736d0f9722f7273d962bb82be
Basic README.

diff -r 00a8d005bc21 -r 10ffb25f0ca2 README.md
--- a/README.md	Wed Apr 05 14:34:04 2017 +0200
+++ b/README.md	Wed Apr 05 14:34:32 2017 +0200
@@ -1,2 +1,22 @@
 # gondole
+
 Go version of the Mastodon API
+
+[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/keltia/gondole) [![license](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/keltia/gondole/master/LICENSE) [![build](https://img.shields.io/travis/keltia/gondole.svg?style=flat)](https://travis-ci.org/keltia/gondole) [![Go Report Card](https://goreportcard.com/badge/github.com/keltia/gondole)](https://goreportcard.com/report/github.com/keltia/gondole)
+
+`gondole` is a [Go](https://golang.org/) library to access the Mastondon [REST API](http://www.rubydoc.info/gems/mastodon-api/Mastodon/REST/API).
+
+**Work in progress, still incomplete**
+
+## Installation
+
+Like many Go-based tools, installation is very easy
+  
+    go get github.com/keltia/gondole
+
+  or
+  
+    git clone https://github.com/keltia/gondole
+    go install ./cmd/...
+
+The library is fetched, compiled and installed in whichever directory is specified by `$GOPATH`.  The `atlas` binary will also be installed.