gempost/README.md

# gempost
An **experimental** gemlog manager for tilde.team

# Quick Start
Basically, gempost manages a *posts.gmi* file and maintains it in a clean format
such that it shows your latest post, your five most recent posts, along with
an archive of all your posts, arranged from newest to oldest.

Doing all this manually would be very tedious.

If you are an existing user, please back up your **public_gemini/** directory and then
proceed with the given steps.

**STEP 1**  
Wih only your *index.gmi* file in **public_gemini/** directory, run the following to set everyting up:  
`gempost init`  

Note that `gempost init` won't work if you don't have gempost added to your path. For tildeverse members, you can just copy the executable to your **~/bin/** directory. Otherwise, you can just do `./gempost <args>` instead of `gempost <args>`.  

**STEP 2**  
Skip this if you chose to initialize an *index.gmi* during `gempost init`.  

gempost doesn't touch your *index.gmi* file, so you will have to manually add a link to *posts.gmi*.  

To do that, just add the following line to your *index.gmi* file:  
`=> ./posts.gmi Posts`

**CONGRATULATIONS!**  
You are ready to use gempost. Please just use `gempost help` from now on to only get a list of commands.

# Notes
This software is experimental and in its early stages. **I am not responsible if you mess up your gemlog using this program.** It works rather fine, and if you are comfortable, I invite you to try it out. To make it perfect, I will have to use it for a long term and work out the long-term posts storage solution.  

Personally, I am happy with the set of features I currently have and will work out the bugs as I find them.  

*This software is provided without any guarantees. Things may break any moment, your posts might get messed up. Keeping backups of your blog directories is always advised.*