From c957beebc83040ec6c9700cc725cc3f49512971e Mon Sep 17 00:00:00 2001 From: TiynGER Date: Sun, 24 May 2020 19:00:50 +0200 Subject: [PATCH] update readme --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ed43901..f4a3196 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ This is a simple blog based on Pythons Flask framework. +## Usage + +### Create entries + +Blog entries are managed by plain html files in the `templates/entry/` directory. +The first line of each document is reserved as the title of the document. +You have to specify the filetype by extension. + +Currently supported filetypes are: +- HTML (.html) +- Markdown (.md) + +## To-Do + +- CSS upgrade + ## Deployment ### PIP/Python @@ -32,19 +48,3 @@ Set the following ports with the -p tag. #### Example run-command `docker run --name blog --restart unless-stopped -v css:/blog/src/static/css -v html:/blog/src/templates -p 80:5000 -d tiynger/flaskblog` - -## Usage - -### Create entries - -Blog entries are managed by plain html files in the `templates/entry/` directory. -The first line of each document is reserved as the title of the document. -You have to specify the filetype by extension. - -Currently supported filetypes are: -- HTML (.html) -- Markdown (.md) - -## To-Do - -- CSS upgrade