Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add version mapping info to readme #63

Merged
merged 4 commits into from
Jun 21, 2019
Merged

chore: add version mapping info to readme #63

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e70971
Add version numbers section to readme
dbjorge Jun 21, 2019
935b8c6
improve wording per feedback
dbjorge Jun 21, 2019
722f39e
Merge branch 'master' into add-version-info-to-readme
dbjorge Jun 21, 2019
ac83c56
Merge branch 'master' into add-version-info-to-readme
dbjorge Jun 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,15 @@ test('my accessibility test', async () => {

The [microsoft/axe-pipelines-samples](https://github.com/microsoft/axe-pipelines-samples) project contains full sample code that walks you through integrating this library into your project, from writing a test to seeing results in Azure Pipelines.

## Version numbers

The version number of this library is **independent** from the version numbers of the axe-core inputs and SARIF outputs it supports.

- axe-sarif-converter version 2.x supports input from version ^3.0.0 of axe-core and outputs SARIF v2.1
- axe-sarif-converter version 1.x supports input from version ^3.0.0 of axe-core and outputs SARIF v2.0

Note that the SARIF format _does not use semantic versioning_, and there are breaking changes between the v2.0 and v2.1 SARIF formats. If you need compatibility with a SARIF viewer that only supports v2.0, you should use version 1.x of this library.

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Expand Down