doc: update README.md

.gitignore

@@ -29,7 +29,6 @@ assets
 # Web files
 *.mp3
 *.mp4
-*.yml
 
 # Nix
 result

Makefile

@@ -17,7 +17,7 @@ prod:
 test:
 	go test -race ./bot/...
 
-install: prod
+install: prod test
 	mkdir -p $(DEST_DIR)
 	cp -r assets $(DEST_DIR)
 	cp $(OUTPUT_DIR)/komputer $(DEST_DIR)
@@ -30,4 +30,4 @@ endif
 clean:
 ifneq ("$(wildcard $(OUTPUT_DIR))", "")
 	rm -r build
-endif
+endif

README.md

@@ -2,10 +2,35 @@
 
 Discord bot behave as like "komputer". One of character in Star Track parody series created by Dem3000
 
+# Installation
+## Manual installation
+Build project and installa with this simple command:
+```sh
+sudo make install
+```
+Bot installs in /opt/komputer directory
+## For NixOS
+You can use flake to install bot as NixOS module:
+
+```nix
+# Installa in flake
+inputs = {
+    komputer.url = "github:Wittano/komputer";
+};
+
+# Activate bot in NixOS
+komputer = {
+    enable = true;
+    token = "<YOUR_DISCORD_TOKEN>";
+    applicationID = "<YOUR_APPLICATION_ID>";
+    guildID = "<YOUR_DISCORD_SERVER_ID>";
+};
+```
+
 # Configuration
 
 Preferred method to deploy for instance of bot is creating docker container using prepared Dockerfile image.
-If you don't want to use docker, you can use `make install` to build and install program. It'll install
+If you don't want to use docker, you can use `sudo make install` to build and install program. It'll install
 in `/opt/komputer` directory.
 
 ## Environment variable
@@ -16,6 +41,5 @@ Bot is configurable via a few environment variables:
 - APPLICATION_ID= Your bot application id (required)
 - SERVER_GUID= Your server ID, where bot will register commands (required)
 - MONGODB_URI= URI to connect MongoDB database (required)
-- MONGODB_DB_NAME= Name of main collection for komputer bot (required)
 - RAPID_API_KEY= API key for RapidAPIs. In project is use: HumorAP (optional)
-- LOG_FILE = Localization of your log file (optional). If you don't use this variable, logs will print on STDOUT
+

nixos/default.nix

@@ -31,6 +31,10 @@ in
           Your token never shouldn't be publish on any public git repository e.g. Github or Gitlab
         '';
       };
+      mongodbURI = mkOption {
+        type = types.str;
+        description = "Connection URI to your instance of mongodb";
+      };
     };
   };
 
@@ -48,6 +52,10 @@ in
         assertion = cfg.applicationID != "";
         message = "Option komputer.applicationID is empty";
       }
+      {
+        assertion = cfg.mongodb != "";
+        message = "Option komputer.mongodbURI is empty";
+      }
     ];
 
     systemd.services.komputer = {
@@ -57,6 +65,7 @@ in
         DISCORD_BOT_TOKEN = cfg.token;
         APPLICATION_ID = cfg.applicationID;
         SERVER_GUID = cfg.guildID;
+        MONGODB_URI = cfg.mongodbURI;
       };
       script = "${cfg.package}/bin/komputer";
     };