external-repos/pa11y-dashboard
2
0
Fork 1
mirror of https://github.com/pa11y/pa11y-dashboard.git synced 2025-09-24 22:31:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document new configuration options

Browse Source
This commit is contained in:
Rowan Manning
2013-11-21 09:21:15 +00:00
parent 8f636173a0
commit 3535b9b11c
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -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. 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 ### port
*(number)* The port to run the application on. *(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 ### siteMessage
*(string)* A message to display prominently on the site home page. Defaults to `null`. *(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 Development
----------- -----------
@@ -92,5 +92,6 @@ pa11y-dashboard is licensed under the [GNU General Public License 3.0][gpl].
[node]: http://nodejs.org/ [node]: http://nodejs.org/
[pa11y]: https://github.com/nature/pa11y [pa11y]: https://github.com/nature/pa11y
[pa11y-webservice]: https://github.com/nature/pa11y-webservice [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]: https://travis-ci.org/nature/pa11y-dashboard
[travis-img]: https://travis-ci.org/nature/pa11y-dashboard.png?branch=master [travis-img]: https://travis-ci.org/nature/pa11y-dashboard.png?branch=master