Add README.md content

Signed-off-by: AKP <tom@tdpain.net>

1 files changed, 51 insertions, 0 deletions

diff --git a/README.md b/README.md
index 2c89cf8..ceed4b6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,54 @@
 # walrss
 
 *Email-based RSS digest generator*
+
+---
+
+![Sample email](.github/screenshots/sampleEmail.png)
+
+![Web UI](.github/screenshots/webUI.png)
+
+## Quickstart: Docker
+
+```bash
+docker pull ghcr.io/codemicro/walrss:latest
+docker run -d -v $(pwd)/walrss-data:/run -p 8080:8080 ghcr.io/codemicro/walrss:latest
+```
+
+## Quickstart: Build from source
+
+You must have an up-to-date version of the Go toolchain installed. Check `go.mod` for the minimum required version.
+
+```bash
+git clone https://github.com/codemicro/walrss.git; cd walrss
+go build github.com/codemicro/walrss/walrss
+```
+
+```bash
+mkdir walrss-data
+WALRSS_DIR="./walrss-data" ./walrss
+```
+
+## Config
+
+Your `config.yaml` file lives in your data directory, which is specified by the `WALRSS_DIR` environment variable (default is `./`).
+
+```yaml
+server:
+  host: 127.0.0.1
+  port: 8080
+  # externalURL is the URL that your instance of Walrss is accessible at
+  # This is a required field
+  externalURL: "http://127.0.0.1:8080"
+email:
+  # Defaults are not provided for any email option
+  # All of the below are required fields
+  password: "yourapikey"
+  username: "apikey"
+  host: "smtp.sendgrid.net"
+  port: 587
+  from: "Walrss <walrss@yourdomain.com>"
+platform:
+  disableRegistration: false
+  disableSecureCookies: false
+```