diff --git a/.goreleaser.yml b/.goreleaser.yml index 649d0bf..74251a8 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -24,8 +24,8 @@ builds: archives: - format: tar.gz files: - - config.toml.sample - README.md + - INSTALL.md - LICENSE dockers: - diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..14ef5c5 --- /dev/null +++ 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`.