From 0d836976e80f6e2273ea67e367f66dd36af85588 Mon Sep 17 00:00:00 2001 From: Paul Robert Lloyd Date: Tue, 16 Aug 2022 16:38:37 +0100 Subject: [PATCH] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0f1c2e2..54cbf02 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Prototype wizard +# GOV.UK Prototype Wizard -Easily build and iterate a ‘one thing per page’ user journey when prototyping GOV.UK services. +Build and iterate ‘one thing per page’ user journeys when prototyping GOV.UK services. -Use it with the [govuk-prototype-kit](https://github.com/alphagov/govuk-prototype-kit). +Use it with the [GOV.UK Prototype Kit](https://govuk-prototype-kit.herokuapp.com/docs). ## Requirements @@ -21,7 +21,7 @@ npm install govuk-prototype-wizard --save The `wizard` helper takes two parameters: 1. A journey object, which defines the default user journey and any branching rules -2. The express request object ('req') +2. The express request object (`req`) It returns a `paths` object with paths for the next, back and the current pages. Any query parameters are kept. @@ -164,7 +164,7 @@ router.post('/wizard/:view', (req, res) => { An example Nunjucks layout extending the default GOV.UK layout: -``` +```njk {% extends "layout.html" %} {% block pageNavigation %} {{ govukBackLink({ @@ -188,7 +188,7 @@ An example Nunjucks layout extending the default GOV.UK layout: ### Build your question pages -``` +```njk {% extends "layouts/wizard.html" %} {% block form %} {{ govukInput({