From 03b4a5c6113324dc9fb7e29c707f9af18e5ab615 Mon Sep 17 00:00:00 2001 From: Elliott Maguire Date: Sun, 18 Jun 2023 15:29:50 -0700 Subject: [PATCH] Update README --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 620e255..89ed619 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,40 @@ A plain and simple blog engine in Go. It serves Markdown files from a folder as HTML with a little bit of styling to make it all bearable and nice. +## Setup + +To get started, you'll need a config like this: + + host: http://localhost:8080 + posts_path: ../posts + emails_path: emails.txt + + meta: + title: My Awesome Blog + author: Me, the Author + email: author@blog.url + links: + Git: https://github.com/me-the-author + YouTube: https://www.youtube.com/channel/me-the-author + + smtp: + host: smtp.mail.com + port: 587 + username: author@blog.url + password: p4ssw0rd + sender: author@blog.url + +You don't have to set up an SMTP server if you don't want; it'll still work +without it, you'll just see some errors in the server logs. + +## Usage + +To launch your blog, use the CLI: + + glean -conf prod.yml -port 80 + +As long as your setup is good, it'll get going and you're in business! + ## Features - [x] On-the-fly Markdown -> HTML conversion for posts