summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNeil Lathwood <neil@lathwood.co.uk>2017-10-30 15:31:42 +0000
committerGitHub <noreply@github.com>2017-10-30 15:31:42 +0000
commit0e1fa67eefe3af9a010a19467f2b68d8d8c84a8b (patch)
tree559a28e5b4714216f490a240d63295f47d9a906e /README.md
parentba717b6d2f1b9b83acd65c12ed3e730a69ff7784 (diff)
parentd5370793448660d0feda249da6104a9d294e055d (diff)
docs: Added help section to docs
Added help section to docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index ee0b426..17b305b 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,8 @@ Oxidized is a network device configuration backup tool. It's a RANCID replacemen
* [Advanced Configuration](docs/Configuration.md#advanced-configuration)
* [Advanced Group Configuration](docs/Configuration.md#advanced-group-configuration)
* [Hooks](docs/Hooks.md)
-5. [Ruby API](docs/Ruby-API.md#ruby-api)
+5. [Help](#help)
+6. [Ruby API](docs/Ruby-API.md#ruby-api)
* [Input](docs/Ruby-API.md#input)
* [Output](docs/Ruby-API.md#output)
* [Source](docs/Ruby-API.md#source)
@@ -297,6 +298,14 @@ chown oxidized:oxidized /var/run/oxidized
update-rc.d oxidized defaults
```
+# Help
+
+If you need help with Oxidized then we have a few methods you can use to get in touch.
+
+ - [Gitter](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - You can join the Lobby on gitter to chat to other Oxidized users.
+ - [GitHub](https://github.com/ytti/oxidized/) - For help and requests for code changes / updates.
+ - [Forum](https://community.librenms.org/c/help/oxidized) - A user forum run by [LibreNMS](https://github.com/librenms/librenms) where you can ask for help and support.
+
# Help Needed
As things stand right now, `oxidized` is maintained by a single person. A great