From ab11478319cf5a119aac673dea23f8856618d8c3 Mon Sep 17 00:00:00 2001
From: Alexandre Morignot <erdnaxeli@cervoi.se>
Date: Mon, 24 Oct 2016 22:43:42 +0200
Subject: [PATCH] README

---
 cmd/jc/README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 cmd/jc/README.md

diff --git a/cmd/jc/README.md b/cmd/jc/README.md
new file mode 100644
index 0000000..054c9f5
--- /dev/null
+++ b/cmd/jc/README.md
@@ -0,0 +1,41 @@
+# JC
+
+Bot to sync Slack or IRC channels together.
+
+## Usage
+
+```
+./jc [--config file]
+```
+
+## Configuration
+
+By default JC reads the file jc.conf in the current directory.
+
+Example:
+```
+transports:
+    irc.iiens.net:
+        type: irc
+        server: irc.iiens.net
+        port: 7000
+        ssl: true
+        ssl_insecure: true
+        channels:
+            - "#list"
+            - "#of"
+            - "#channels"
+    yourteam.slack.com:
+        type: slack
+        token: secret_bot_token
+links:
+    - irc.iiens.net:
+        - "#channels"
+      yourteam.slack.com:
+        - aslackchannel
+      filters:
+        - some
+        - nicks
+        - to
+        - ignore
+```
-- 
GitLab