Skip to content

Commit

Permalink
Version 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
josebolos committed Nov 26, 2021
1 parent 0ebd9e5 commit 01ded41
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 27 deletions.
7 changes: 4 additions & 3 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@

# Migration Guide

Pa11y's API changes between major versions. This is a guide to help you make the switch when this happens.

## Migrating from 1.x to 2.x
## Migrating from 2.x to 3.x

### Node.js Support
Pa11y Webservice Client 3.x only supports Node.js v12 and higher, you'll need to upgrade to be able to use it.

## Migrating from 1.x to 2.x

Pa11y Webservice Client 2.x only supports Node.js v8.0.0 and higher, you'll need to upgrade to be able to use it.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,21 @@

Pa11y Webservice Node.js Client
===============================
# Pa11y Webservice Node.js Client

This is a Node.js client library for [Pa11y Webservice][pa11y-webservice].

**Current Version:** *2.0.0*
**Build Status:** [![Build Status][travis-img]][travis]
**Node Version Support:** *8+*
[![NPM version][shield-npm]][info-npm]
[![Node.js version support][shield-node]][info-node]
[![Build status][shield-build]][info-build]
[![LGPL-3.0 licensed][shield-license]][info-license]

Installing
----------
## Installing

Install Pa11y Webservice Node.js Client with npm:

```sh
$ npm install pa11y-webservice-client-node
```

Usage
-----
## Usage

For more information on the actual webservice endpoints and resource types, [read the documentation][wiki-web-service].

Expand Down Expand Up @@ -131,9 +128,7 @@ client.task('5231c687bbdf0f94fa000007').result('523c0ee0ca452f0000000009').get({
});
```


Contributing
------------
## Contributing

There are many ways to contribute to Pa11y Webservice Node.js Client, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.

Expand All @@ -151,29 +146,34 @@ Code with lint errors or failing tests will not be accepted, please use the buil

For users with push-access, don't commit to the master branch. Code should be in `develop` until it's ready to be released.

Support and Migration
---------------------
## Support and Migration

Major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version.

We also maintain a [migration guide](MIGRATION.md) to help you migrate.

| :grey_question: | Major Version | Last Release | Node.js Versions | Support End Date |
| :-------------- | :------------ | :----------- | :--------------- | :--------------- |
| :heart: | 2 | N/A | 8+ | N/A |
| :hourglass: | 1 | 1.2.1 | 0.10+ | 2020-01-05 |
| :heart: | 3 | N/A | 12+ | N/A |
| :hourglass: | 2 | 2.0.0 | 8+ | 2022-05-26 |
| :skull: | 1 | 1.2.1 | 0.10+ | 2020-01-05 |

If you're opening issues related to these, please mention the version that the issue relates to.

License
-------
## License

Licensed under the [GNU General Public License 3.0](LICENSE.txt).<br/>
Copyright &copy; 2013–2019, Team Pa11y

[gpl]: http://www.gnu.org/licenses/gpl-3.0.html
[grunt]: http://gruntjs.com/
[pa11y-webservice]: https://github.com/pa11y/pa11y-webservice
[travis]: https://travis-ci.org/pa11y/pa11y-webservice-client-node
[travis-img]: https://travis-ci.org/pa11y/pa11y-webservice-client-node.png?branch=master
[wiki-web-service]: https://github.com/pa11y/pa11y-webservice/wiki/Web-Service-Endpoints
[info-build]: https://github.com/pa11y/pa11y-webservice-client-node/actions/workflows/build-and-test.yml
[info-license]: LICENSE
[info-node]: package.json
[info-npm]: https://www.npmjs.com/package/pa11y-webservice-client-node
[shield-build]: https://github.com/pa11y/pa11y-webservice-client-node/actions/workflows/build-and-test.yml/badge.svg
[shield-license]: https://img.shields.io/badge/license-LGPL%203.0-blue.svg
[shield-node]: https://img.shields.io/node/v/pa11y-webservice-client-node.svg
[shield-npm]: https://img.shields.io/npm/v/pa11y-webservice-client-node.svg
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "pa11y-webservice-client-node",
"version": "2.0.0",
"version": "3.0.0",
"engines": {
"node": ">=8"
"node": ">=12"
},
"description": "pa11y-webservice-client-node is a Node.js client library for pa11y-webservice",
"keywords": [
Expand Down

0 comments on commit 01ded41

Please sign in to comment.