README.md
author Ollivier Robert <roberto@keltia.net>
Tue, 11 Apr 2017 10:22:44 +0200
changeset 62 4b861c82e5f6
parent 52 825b890aff85
child 137 acaea3179f4d
permissions -rw-r--r--
Update install instructions. Found by: @_bapt_@mastodon.social
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
3a990ffb9368 Initial commit
Ollivier Robert <roberto@keltia.net>
parents:
diff changeset
     1
# gondole
2
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
     2
0
3a990ffb9368 Initial commit
Ollivier Robert <roberto@keltia.net>
parents:
diff changeset
     3
Go version of the Mastodon API
2
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
     4
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
     5
[![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)
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
     6
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
     7
`gondole` is a [Go](https://golang.org/) library to access the Mastondon [REST API](http://www.rubydoc.info/gems/mastodon-api/Mastodon/REST/API).
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
     8
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
     9
**Work in progress, still incomplete**
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    10
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    11
## Installation
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    12
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    13
Like many Go-based tools, installation is very easy
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    14
  
62
4b861c82e5f6 Update install instructions.
Ollivier Robert <roberto@keltia.net>
parents: 52
diff changeset
    15
    go get github.com/keltia/gondole/cmd/...
2
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    16
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    17
  or
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    18
  
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    19
    git clone https://github.com/keltia/gondole
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    20
    go install ./cmd/...
10ffb25f0ca2 Basic README.
Ollivier Robert <roberto@keltia.net>
parents: 0
diff changeset
    21
52
825b890aff85 Fix binary name.
Ollivier Robert <roberto@keltia.net>
parents: 32
diff changeset
    22
The library is fetched, compiled and installed in whichever directory is specified by `$GOPATH`.  The `gondole-cli` binary will also be installed. 
3
c62478adcd24 Explain gondole.
Ollivier Robert <roberto@keltia.net>
parents: 2
diff changeset
    23
32
c28f7e417146 Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents: 11
diff changeset
    24
## Configuration
c28f7e417146 Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents: 11
diff changeset
    25
c28f7e417146 Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents: 11
diff changeset
    26
The configuration is stored in the standard place: `$HOME/.config/gondole`.  You can find a global configuration file named `config.toml`and a file for each instance you have connected with, named `<instance>.toml`.
c28f7e417146 Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents: 11
diff changeset
    27
c28f7e417146 Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents: 11
diff changeset
    28
When you connect `gondole` to a given instance you have never connected before, it will register the application, get the token and save it.
c28f7e417146 Point to configuration files.
Ollivier Robert <roberto@keltia.net>
parents: 11
diff changeset
    29
3
c62478adcd24 Explain gondole.
Ollivier Robert <roberto@keltia.net>
parents: 2
diff changeset
    30
## Name
c62478adcd24 Explain gondole.
Ollivier Robert <roberto@keltia.net>
parents: 2
diff changeset
    31
c62478adcd24 Explain gondole.
Ollivier Robert <roberto@keltia.net>
parents: 2
diff changeset
    32
Trying to define a name close to *Mastodon*, one could come up with *godon* and in French, *gondole* (the small boats in Venice) is easy to take.
c62478adcd24 Explain gondole.
Ollivier Robert <roberto@keltia.net>
parents: 2
diff changeset
    33
6
47035af1f167 Add references to docs.
Ollivier Robert <roberto@keltia.net>
parents: 3
diff changeset
    34
## References
47035af1f167 Add references to docs.
Ollivier Robert <roberto@keltia.net>
parents: 3
diff changeset
    35
11
39a5ce85e9de Add link to main API description.
Ollivier Robert <roberto@keltia.net>
parents: 6
diff changeset
    36
- [Mastodon API doc](https://github.com/tootsuite/mastodon/blob/master/docs/Using-the-API/API.md)
6
47035af1f167 Add references to docs.
Ollivier Robert <roberto@keltia.net>
parents: 3
diff changeset
    37
- [Mastodon Ruby API](http://www.rubydoc.info/gems/mastodon-api/Mastodon/REST/API)
47035af1f167 Add references to docs.
Ollivier Robert <roberto@keltia.net>
parents: 3
diff changeset
    38
- [Mastodon Python](https://mastodonpy.readthedocs.io/en/latest/)
47035af1f167 Add references to docs.
Ollivier Robert <roberto@keltia.net>
parents: 3
diff changeset
    39
- [Mastodon repo](https://github.com/tootsuite/mastodon)