rearrange navLinks, update readme

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

diff --git a/README.md b/README.md
index 66d16fd19dcee2f060d972d0944fce7192cec45f..32f26735ed6ed6e276ff6850b4ee73a3dd9bb508 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,7 +6,16 @@ Specific to Squeep Framework Applications, this module has strong opinions and m
 
 ## 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
 
@@ -15,8 +24,8 @@ The context is referenced for authenticated user information, as well as messagi
 - `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`.
+If either of these are present, navigation links are added to the page header allowing the user to manage their account or log out.  
+The links will point relatively to `/admin/settings` and `/admin/logout`, respectively.
 
 - `ctx.url`
 
@@ -26,6 +35,7 @@ If present, added as a query parameter (`r`, for redirect) to the logout link.
 - `ctx.notifications`
 
 Lists of errors and notices to show at top of page, before main content.
+`initContext` will create the arrays.
 
 ### Options
 
@@ -40,3 +50,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.`
+
+## Tests
+
+`LintHtml` class is a simple wrapper around html-validate package which can report issues with generated html strings.