Add readme with example

2017-10-30 21:19:07 +01:00 · 2017-10-30 21:19:07 +01:00 · b8d13bbdbc
commit b8d13bbdbc
parent 7b41841dd2
1 changed files with 53 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,53 @@
+# Ciclostile
+
+
+## TODO
+
+- select input and output folders and template by parameters or config file.
+
+
+## Example
+
+Input markdown:
+
+```markdown
+Title: Home Page
+
+# Site
+
+Some text
+```
+
+
+Template:
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>{{ title }}</title>
+  </head>
+  <body>
+
+{{ content }}
+
+  </body>
+</html>
+```
+
+Output html:
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Home Page</title>
+  </head>
+  <body>
+
+<h1>Site</h1>
+<p>Some text</p>
+
+  </body>
+</html>
+```