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

Bring the README into line with newer projects

Browse Source
This commit is contained in:
Rowan Manning
2016-05-22 11:45:57 +01:00
parent 6a1e06a435
commit 4eb2fba6aa
2 changed files with 15 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
LICENSE.txt → LICENSE
View File

22
README.md
View File

@@ -3,9 +3,10 @@ pa11y-dashboard
pa11y-dashboard is a web interface to the [pa11y][pa11y] accessibility reporter; allowing you to focus on *fixing* issues rather than hunting them down. pa11y-dashboard is a web interface to the [pa11y][pa11y] accessibility reporter; allowing you to focus on *fixing* issues rather than hunting them down.
**Current Version:** *1.10.0* ![Version][shield-version]
**Build Status:** [![Build Status][travis-img]][travis] [![Node.js version support][shield-node]][info-node]
**Node Version Support:** *0.10* [![Build status][shield-build]][info-build]
[![GPL-3.0 licensed][shield-license]][info-license]
--- ---
@@ -23,7 +24,7 @@ Setup
pa11y-dashboard requires [Node.js][node] 0.10+ and [PhantomJS][phantom]. See the [pa11y][pa11y] documentation for detailed instructions on how to install these dependencies on your operating system. pa11y-dashboard requires [Node.js][node] 0.10+ and [PhantomJS][phantom]. See the [pa11y][pa11y] documentation for detailed instructions on how to install these dependencies on your operating system.
You'll also need to have [MongoDB][mongo] installed and running. See the [MongoDB install guide][mongo-install] for more information on this. You'll also need to have [MongoDB][mongo] installed and running. See the [MongoDB install guide][mongo-install] for more information on this.
You'll then need to clone this repo locally and install dependencies with `npm install`. You'll then need to clone this repo locally and install dependencies with `npm install`.
@@ -103,12 +104,11 @@ Useful Resources
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitialOcean][resource-una-k] * [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitialOcean][resource-una-k]
License License
------- -------
[Copyright 2016 Springer Nature](LICENSE.txt). pa11y-dashboard is licensed under the [GNU General Public License 3.0][info-license].
pa11y-dashboard is licensed under the [GNU General Public License 3.0][gpl]. Copyright © 2013–2016, Springer Nature
@@ -123,3 +123,11 @@ pa11y-dashboard is licensed under the [GNU General Public License 3.0][gpl].
[sidekick-proposal]: https://github.com/pa11y/sidekick/blob/master/PROPOSAL.md [sidekick-proposal]: https://github.com/pa11y/sidekick/blob/master/PROPOSAL.md
[travis]: https://travis-ci.org/springernature/pa11y-dashboard [travis]: https://travis-ci.org/springernature/pa11y-dashboard
[travis-img]: https://travis-ci.org/springernature/pa11y-dashboard.png?branch=master [travis-img]: https://travis-ci.org/springernature/pa11y-dashboard.png?branch=master
[info-license]: LICENSE
[info-node]: package.json
[info-build]: https://travis-ci.org/springernature/pa11y-dashboard
[shield-license]: https://img.shields.io/badge/license-GPL%203.0-blue.svg
[shield-node]: https://img.shields.io/badge/node.js%20support-0.10-brightgreen.svg
[shield-version]: https://img.shields.io/badge/version-1.10.0-blue.svg
[shield-build]: https://img.shields.io/travis/springernature/pa11y-dashboard/master.svg