Add install readme file

runningnoodle · Jul 12, 2019 · 349562f · 349562f
1 parent e64d723
commit 349562f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -24,6 +24,6 @@ builds:
 archives:
   - format: tar.gz
     files:
-      - config.toml.sample
       - README.md
+      - INSTALL.md
       - LICENSE
diff --git a/INSTALL.md b/INSTALL.md
@@ -0,0 +1,5 @@
+# Install and run
+
+- Run `./listmonk --new-config` to generate a sample `config.toml` and add your configuration (SMTP and Postgres DB credentials primarily).
+- `./listmonk --install` to setup the DB.
+- Visit `http://localhost:9000`.