bump package version to 1.6.1

[squeep-html-template-helper] / README.md

diff --git a/README.md b/README.md
index 66d16fd19dcee2f060d972d0944fce7192cec45f..68f91ea85a20c2247666df5b4c20f1820cc03420 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,28 +4,28 @@ Simplistic helpers for rendering HTML and boilerplate.
 
 Specific to Squeep Framework Applications, this module has strong opinions and makes many assumptions.
 
 
 Specific to Squeep Framework Applications, this module has strong opinions and makes many assumptions.
 

+Expects `/static/theme.css` and `/static/custom.css` to exist.
+

 ## API
 
 ## API
 

-`htmlPage(pagePathLevel, ctx, options, main = [])`
+- `initContext(ctx)`
+- `htmlPage(pagePathLevel, ctx, options, main = [])`
+- `dateOrNot(date, otherwise)`
+- `dateFormat(date, pInf nInf, otherwise)`
+- `timeElement(date, options)`
+- `secondsToPeriod(seconds)`
+- `indented(intent, list)`
+- `UL(items, indent, attributes, itemAttributesGenerator)`
+- `OL(items, indent, attributes, itemAttributesGenerator)`
+- `LI(item, indent, attributes)`

 
 ### Context
 
 
 ### Context
 

-The context is referenced for authenticated user information, as well as messaging.
-
-- `ctx.session.authenticatedIdentifier`
-- `ctx.session.authenticatedProfile`
-
-If either of these are present, a navigation link is added to the page header allowing the user to log out.  
-The link will point relatively to `/admin/logout`.
-
-- `ctx.url`
-
-If present, added as a query parameter (`r`, for redirect) to the logout link.
-

 - `ctx.errors`
 - `ctx.notifications`
 
 Lists of errors and notices to show at top of page, before main content.
 - `ctx.errors`
 - `ctx.notifications`
 
 Lists of errors and notices to show at top of page, before main content.

+`initContext` will create the arrays.

 
 ### Options
 
 
 ### Options
 


@@ -40,3 +40,7 @@ Lists of errors and notices to show at top of page, before main content.
 - `options.notificationHeading` - h2 for notice section
 - `options.notificationContent` - additional information included ahead of list of notices
 - `options.`
 - `options.notificationHeading` - h2 for notice section
 - `options.notificationContent` - additional information included ahead of list of notices
 - `options.`

+
+## Tests
+
+`LintHtml` class is a simple wrapper around `html-validate` package which can report issues with generated html strings.