mount substitution

[pinopress.git] / README.md

diff --git a/README.md b/README.md
index e7fb04f..2a202a7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 # pinopress
 
 **pinopress** is a modular makefile based static blog generator. that means you run the build script once and every page is generated beforehand.
+**pinopress** also focuses on extensibility, you can hook your own shell scripts into the build process to easily add any new features.
 
 built in features include markdown generated blog articles, and a rss feed.
 
@@ -23,7 +24,7 @@ these have not been implemented yet, but modules are shellscripts that are calle
 
 here are some potential ideas for modules:
 - [ ] syntax highlight for code blocks
-- [ ] blog average time to read
+- [x] blog average time to read
 
 ## pinopress flavored markdown
 
@@ -37,9 +38,9 @@ pinopress articles are written in an enhanced version of markdown. specification
 
 `$SITEURL` - the SITEURL variable you set in the pinopress config
 
-`$USERVAR1` - global variable you can use however you want
+`$USERGLOBAL1` - global variable you can use however you want
 
-`$USERVAR2` - a second user defined global variable
+`$USERGLOBAL2` - a second user defined global variable
 
 ### article only
 
@@ -47,7 +48,25 @@ pinopress articles are written in an enhanced version of markdown. specification
 
 `$PUBLISHED_DATE` - the date/time the article was published, as set in the article header
 
+`$DESCRIPTION` - brief description of the blog post
+
+`$USERLOCAL1` - article specific variable you can use for whatever you want
+
+`$USERLOCAL2` - another user local variable
+
 ## mounts
 
-coming soon...
+mounts are the **pinopress** solution to html includes. to include any file from the template directory, use the following syntax:
+```
+<!-- MOUNT_[NAMEOFFILE] -->
+```
+note that the name of file is without any extensions and in all caps. also, mounts are **not** expanded recursively.
+
+**pinopress** also has the following builtin mounts that are used internally, prefixed by an underscore:
+```
+<!-- _MOUNT_ARTICLECONTENT -->
+<!-- _MOUNT_ROLLINGITEM -->
+<!-- _MOUNT_ARCHIVEITEM -->
+<!-- _MOUNT_FEEDITEM -->
+```