status-im
/
matterbridge
mirror of https://github.com/status-im/matterbridge.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README

This commit is contained in:
Wim 2019-04-14 23:48:54 +02:00
parent 220485a849
commit 8513a07416
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -50,9 +50,10 @@
* [Screenshots](https://github.com/42wim/matterbridge/wiki/) * [Screenshots](https://github.com/42wim/matterbridge/wiki/)
* [Installing](#installing) * [Installing](#installing)
* [Binaries](#binaries) * [Binaries](#binaries)
* [Building](#building) * [Building](#building)
* [Configuration](#configuration) * [Configuration](#configuration)
* [Howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) * [Howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config)
* [Settings](#settings)
* [Examples](#examples) * [Examples](#examples)
* [Running](#running) * [Running](#running)
* [Docker](#docker) * [Docker](#docker)
@ -97,7 +98,7 @@
* [Discourse](https://github.com/DeclanHoare/matterbabble) * [Discourse](https://github.com/DeclanHoare/matterbabble)
### API ### API
The API is very basic at the moment. The API is basic at the moment.
More info and examples on the [wiki](https://github.com/42wim/matterbridge/wiki/Api). More info and examples on the [wiki](https://github.com/42wim/matterbridge/wiki/Api).
Used by the projects below. Feel free to make a PR to add your project to this list. Used by the projects below. Feel free to make a PR to add your project to this list.
@ -135,7 +136,7 @@ See https://github.com/42wim/matterbridge/wiki
### Packages ### Packages
* [Overview](https://repology.org/metapackage/matterbridge/versions) * [Overview](https://repology.org/metapackage/matterbridge/versions)
### Building ## Building
Go 1.9+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed, including setting up your [GOPATH](https://golang.org/doc/code.html#GOPATH). Go 1.9+ is required. Make sure you have [Go](https://golang.org/doc/install) properly installed, including setting up your [GOPATH](https://golang.org/doc/code.html#GOPATH).
After Go is setup, download matterbridge to your $GOPATH directory. After Go is setup, download matterbridge to your $GOPATH directory.
@ -156,6 +157,9 @@ matterbridge
### Basic configuration ### Basic configuration
See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration. See [howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) for a step by step walkthrough for creating your configuration.
### Settings
All possible [settings](https://github.com/42wim/matterbridge/wiki/Settings) for each bridge.
### Advanced configuration ### Advanced configuration
* [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example. * [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example.