Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
glotchimo committed Jun 18, 2023
1 parent 5e6859c commit 03b4a5c
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: [email protected]
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: [email protected]
password: p4ssw0rd
sender: [email protected]

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
Expand Down

0 comments on commit 03b4a5c

Please sign in to comment.