Adds basic readme

This commit is contained in:
Sloom Sloum Sluom IV 2024-05-15 17:43:34 +00:00
parent 94bae556ed
commit 9764177712

14 Normal file
View File

@ -0,0 +1,14 @@
# shlog
A local, plaintext blogging system for, based on the prior work of--I believe--papa.
For usage:
``` sh
shlog help
# shlog -h
# shlog --help
To use the default setup for indexing (rather than a local index) you will need to create `/usr/local/share/shlog` and have it writable for the user creating the index (easiest to set their user as the group and give permissions to the group for writing.