summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWim <wim@42.be>2019-04-14 23:48:54 +0200
committerWim <wim@42.be>2019-04-14 23:48:54 +0200
commit8513a07416138b5c6badb9d2ad352c869308eb63 (patch)
tree7e8219ae9588916a5023b357e9c2bf1ba4cb39b0
parent220485a849ad1c03ee8ce74f9af45b9d6088f9cf (diff)
downloadmatterbridge-msglm-8513a07416138b5c6badb9d2ad352c869308eb63.tar.gz
matterbridge-msglm-8513a07416138b5c6badb9d2ad352c869308eb63.tar.bz2
matterbridge-msglm-8513a07416138b5c6badb9d2ad352c869308eb63.zip
Update README
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 3ee560b6..5638c8e2 100644
--- a/README.md
+++ b/README.md
@@ -50,9 +50,10 @@
* [Screenshots](https://github.com/42wim/matterbridge/wiki/)
* [Installing](#installing)
* [Binaries](#binaries)
- * [Building](#building)
+ * [Building](#building)
* [Configuration](#configuration)
* [Howto](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config)
+ * [Settings](#settings)
* [Examples](#examples)
* [Running](#running)
* [Docker](#docker)
@@ -97,7 +98,7 @@
* [Discourse](https://github.com/DeclanHoare/matterbabble)
### 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).
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
* [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).
After Go is setup, download matterbridge to your $GOPATH directory.
@@ -156,6 +157,9 @@ matterbridge
### 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.
+### Settings
+All possible [settings](https://github.com/42wim/matterbridge/wiki/Settings) for each bridge.
+
### Advanced configuration
* [matterbridge.toml.sample](https://github.com/42wim/matterbridge/blob/master/matterbridge.toml.sample) for documentation and an example.