Merge branch 'master' of github.com:r-raymond/nixos-mailserver

1 files changed, 29 insertions, 1 deletions

diff --git a/README.md b/README.md
index 7c3393d..cfdc99b 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ None so far.
 
 ### v1.2
   * Certificates
-    - [ ] Let's Encrypt
+    - [x] Let's Encrypt
   * Sieves
     - [ ] Allow user defined sieve scripts
   * User Aliases
@@ -51,6 +51,34 @@ None so far.
  * Changed structure to Nix Modules
  * Adds Sieve support
 
+### How to Deploy
+
+```nix
+{ config, pkgs, ... }:
+{
+  imports = [
+    (builtins.fetchTarball "https://github.com/r-raymond/nixos-mailserver/releases/tag/v1.1-rc2")
+  ];
+ 
+  mailserver = {
+    enable = true;
+    domain = "example.com";
+    login_accounts = {
+      user1 = {
+        name = "test";
+        hashedPassword = "$6$Mmmx1U68$Twd8acMxqHoqFyfz3SPz1pzjY/D36gayAdpUTFMvfrHQUwObF3acuLz2GYAGFzsjHLEK/dPIv3pCwj3kZ5T2u.";
+      };
+    };
+    virtualAliases = {
+      admin = "user1";
+    };
+  };
+}
+```
+
+For a complete list of options, see `default.nix`.
+
+
 ### How to Test
 
 You can test the setup via `nixops`. After installation, do