From 9dd4633ae6a73c1961f202e9d67a446bc7fd44e9 Mon Sep 17 00:00:00 2001 From: Dan Bjorge Date: Fri, 21 Jun 2019 13:00:15 -0700 Subject: [PATCH] chore: add version mapping info to readme (#63) Adds a "Version numbers" section to the README that describes the mappings between axe-sarif-converter version and axe-core/SARIF format versions. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index da78d708..9eec31c9 100644 --- a/README.md +++ b/README.md @@ -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