about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README10
1 files changed, 8 insertions, 2 deletions
diff --git a/README b/README
index f8aefaa..93fac3e 100644
--- a/README
+++ b/README
@@ -24,7 +24,7 @@ And some stretch goals to turn it into a blog generator:
 strike.ini file
 ---------------
 
-Strike should be passed the location of a .ini file or a directory containing a file named strike.ini. This is a text file in Python's configparser format (for now). You can see an example config file in the sample directory.
+Strike should be passed the location of a .ini file or a directory containing a file named strike.ini. This is a text file in Python's configparser format (for now). You can see an example config file with all supported options at sample/strike.ini.
 
 Markup
 ------
@@ -36,7 +36,13 @@ It generates <section>s and has specific markup for page titles.
 Templating
 ----------
 
-TBD. Right now, templates should be written in plain HTML. The special marker ${content} will be replaced with all custom page content (also in raw HTML).
+TBD. 
+
+Right now, templates are just HTML in a Python f-string. You have access to the following variables:
+
+{content} : Complete file contents.
+{meta['title']} : Filename, with extension dropped.
+{meta['date']} : File modification date.
 
 Front matter
 ------------