X-Git-Url: http://git.squeep.com/?p=squeep-html-template-helper;a=blobdiff_plain;f=README.md;h=c6f92261925b04abe67a34bbce9b18906a51364d;hp=32f26735ed6ed6e276ff6850b4ee73a3dd9bb508;hb=HEAD;hpb=eb018a6fe29fc8c13841c94e894e5aff192ea73f diff --git a/README.md b/README.md index 32f2673..68f91ea 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Simplistic helpers for rendering HTML and boilerplate. 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 - `initContext(ctx)` @@ -19,18 +21,6 @@ Specific to Squeep Framework Applications, this module has strong opinions and m ### 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, 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` - -If present, added as a query parameter (`r`, for redirect) to the logout link. - - `ctx.errors` - `ctx.notifications` @@ -53,4 +43,4 @@ Lists of errors and notices to show at top of page, before main content. ## Tests -`LintHtml` class is a simple wrapper around html-validate package which can report issues with generated html strings. +`LintHtml` class is a simple wrapper around `html-validate` package which can report issues with generated html strings.