From 696ae6c8ce77860cb68b8342e5f8e7234c9b2c56 Mon Sep 17 00:00:00 2001 From: noah morrison Date: Fri, 28 Nov 2014 10:09:12 -0500 Subject: [PATCH] Updated the readme --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cb37375..325e141 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,25 @@ USAGE Commandline usage: (if installed via pypi) ``` -$ chevron [data file] [template file] +usage: chevron [-h] [-d DATA] [-p PARTIALS_PATH] [-e PARTIALS_EXT] + [-l DEF_LDEL] [-r DEF_RDEL] + template + +positional arguments: + template The mustache file + +optional arguments: + -h, --help show this help message and exit + -d DATA, --data DATA The json data file + -p PARTIALS_PATH, --path PARTIALS_PATH + The directory where your partials reside + -e PARTIALS_EXT, --ext PARTIALS_EXT + The extension for your mustache partials, 'mustache' + by default + -l DEF_LDEL, --left-delimiter DEF_LDEL + The default left delimiter, "{{" by default. + -r DEF_RDEL, --right-delimiter DEF_RDEL + The default right delimiter, "}}" by default. ``` Python usage with strings @@ -125,6 +143,9 @@ $ pip install chevron TODO --- +* add postmortem debugging +* add caching of templates + * get popular * have people complain * fix those complaints -- 2.47.3