From 3535b9b11cda02741cc22a6815015d26f7318277 Mon Sep 17 00:00:00 2001 From: Rowan Manning Date: Thu, 21 Nov 2013 09:21:15 +0000 Subject: [PATCH] Document new configuration options --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index afa53b5..0cbad8e 100644 --- a/README.md +++ b/README.md @@ -43,9 +43,6 @@ Configurations The boot configurations for pa11y-dashboard are as follows. Look at the sample JSON files in the repo for example usage. -### webservice -*(string)* The base URL of the [pa11y-webservice][pa11y-webservice] instance you intend on using. - ### port *(number)* The port to run the application on. @@ -58,6 +55,9 @@ The boot configurations for pa11y-dashboard are as follows. Look at the sample J ### siteMessage *(string)* A message to display prominently on the site home page. Defaults to `null`. +### webservice +This can either be an object containing [pa11y-webservice configurations][pa11y-webservice-config], or a string which is the base URL of a [pa11y-webservice][pa11y-webservice] instance you are running separately. + Development ----------- @@ -92,5 +92,6 @@ pa11y-dashboard is licensed under the [GNU General Public License 3.0][gpl]. [node]: http://nodejs.org/ [pa11y]: https://github.com/nature/pa11y [pa11y-webservice]: https://github.com/nature/pa11y-webservice +[pa11y-webservice-config]: https://github.com/nature/pa11y-webservice#configurations [travis]: https://travis-ci.org/nature/pa11y-dashboard [travis-img]: https://travis-ci.org/nature/pa11y-dashboard.png?branch=master