From 428d1b9565cb9a7c5ea61eaaa5358354912488e8 Mon Sep 17 00:00:00 2001
From: Miguel <m.i@gmx.at>
Date: Wed, 20 Feb 2019 14:31:57 +0100
Subject: added example page

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 7a42498..4d03cc1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
 # estatico
 
-This is a simple static website generator coded in haskell by miguel
+This is a simple static website generator coded in Haskell.
+It uses pandoc for the heavy work, as syntax highlighting and parsing 
+of the markdown files.
+
+## features
+
+* No Database
+* Only Static Content
+* Sitemap derived from Directory Tree
+* Simple Markdown Files
+
+# gitweb
+
+https://github.com/miguelclean/estatico
+
+# dockerhub
+
+https://hub.docker.com/r/migueldirty/estatico/builds
+
+# example usage
+
+__NOTE: make sure DIR\_OUT exists and is a free directory__
+
+You can use the example websites inside the examples/ directory for a start.
+
+Inside the input directory (e.g. ./examples/example01/) run something along this lines:
+
+    DIR_IN=`pwd`
+    DIR_OUT=/mnt/yourwebsiteroot
+    HTML_ROOT=https://www.example.com
+    SUDO=sudo
+    IMAGE=migueldirty/estatico
+    ${SUDO} docker run --rm -v${DIR_IN}:/in:ro -v${DIR_OUT}:/out:rw ${IMAGE} /in /out ${HTML_ROOT}
+
+Or if you want to test it locally use some local DIR\_OUT and HTML\_ROOT instead:
+
+    DIR_OUT=/home/miguel/testpage
+    HTML_ROOT=/home/miguel/testpage
+
-- 
cgit v1.2.3