Add example of configuration file into README.md

zstyblik · Apr 6, 2024 · ed87f81 · ed87f81
1 parent cc5ffa3
commit ed87f81
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,18 @@ Features:
 * configuration file in order to support multiple instances of bot
 * auto reconnect
 
+## Configuration file
+
+Example of configuration file:
+
+```
+net:irc.example.com:#chan1 #chan2
+nickname:testme
+ircdir:$HOME/ii/
+bitly_api_token:api_token
+bitly_group_id:group_id
+```
+
 ## UnLicense
 
 Since the original is [UnLicense]-d, I've decided to follow the suit.