fix docs

Author: jfk9w

README.md

@@ -61,6 +61,64 @@ Hikkabot requires a JSON configuration file. The path must be provided as the fi
 
 You can use [this skeleton](https://github.com/jfk9w/hikkabot/blob/master/config.json) to build the configuration upon.
 
+#### Description
+
+```json5
+{
+  // Your telegram user ID
+  "AdminID": 12345678,
+  "Storage": {
+    // SQL driver to be used
+    "Driver": "postgres",
+    // Datasource connection string
+    "Datasource": "postgres://postgres:postgres@postgres/postgres"
+  },
+  // How often should subscription update check occur
+  "UpdateInterval": "10s",
+  // Aliases allow to map certain CHAT_REFs to telegram chat IDs
+  // May be useful for managing private channels and aliasing long channel usernames
+  "Aliases": {
+    "my_ref": -10000000000000000
+  },
+  "Telegram": {
+    // Telegram Bot API token
+    "Token": "2352626236:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
+  },
+  "Media": {
+    "Aconvert": {
+      // Maximum queue size fot aconvert.com client
+      "QueueSize": 100,
+      // Times a failed request will be retried
+      "MaxRetries": 3,
+      // Test file is used for aconvert.com client initialization
+      // Should be a path to any media file supported by aconvert.com
+      "TestFile": "test_media.webm",
+      // Test format is used for aconvert.com client initialization
+      // This is a target format for a media file specified above
+      "TestFormat": "mp4"
+    },
+    // Number of maximum simultaneous media downloads
+    "Workers": 13,
+    // Temporary directory for media files
+    "TempDir": "/tmp/hikkabot"
+  },
+  "Dvach": {
+    // 2ch.hk client is updated with a cookie with this usercode
+    // This may allow to access /e/, /hc/, etc.
+    "Usercode": "fcdebafcde8642143"
+  },
+  "Reddit": {
+    "ClientID": "iuYGY&b328fd",
+    "ClientSecret": "a088HUUIHEAFjn9hesg",
+    "Username": "username",
+    "Password": "password",
+    "UserAgent": "Your user agent 5.0",
+    // Times a failed request will be retried
+    "MaxRetries": 3
+  }
+}
+```
+
 ### Installation and execution
 
 Install using Go package manager:

config.json

@@ -1,44 +1,27 @@
 {
-  // Your telegram user ID
   "AdminID": 12345678,
   "Storage": {
-    // SQL driver to be used
     "Driver": "postgres",
-    // Datasource connection string
     "Datasource": "postgres://postgres:postgres@postgres/postgres"
   },
-  // How often should subscription update check occur
   "UpdateInterval": "10s",
-  // Aliases allow to map certain CHAT_REFs to telegram chat IDs
-  // May be useful for managing private channels and aliasing long channel usernames
   "Aliases": {
     "my_ref": -10000000000000000
   },
   "Telegram": {
-    // Telegram Bot API token
     "Token": "2352626236:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
   },
   "Media": {
     "Aconvert": {
-      // Maximum queue size fot aconvert.com client
       "QueueSize": 100,
-      // Times a failed request will be retried
       "MaxRetries": 3,
-      // Test file is used for aconvert.com client initialization
-      // Should be a path to any media file supported by aconvert.com
       "TestFile": "test_media.webm",
-      // Test format is used for aconvert.com client initialization
-      // This is a target format for a media file specified above
       "TestFormat": "mp4"
     },
-    // Number of maximum simultaneous media downloads
     "Workers": 13,
-    // Temporary directory for media files
     "TempDir": "/tmp/hikkabot"
   },
   "Dvach": {
-    // 2ch.hk client is updated with a cookie with this usercode
-    // This may allow to access /e/, /hc/, etc.
     "Usercode": "fcdebafcde8642143"
   },
   "Reddit": {
@@ -47,7 +30,6 @@
     "Username": "username",
     "Password": "password",
     "UserAgent": "Your user agent 5.0",
-    // Times a failed request will be retried
     "MaxRetries": 3
   }
 }