From 02ea409a140269b32d6a8c0466304cf812e5e209 Mon Sep 17 00:00:00 2001 From: Luke Wright Date: Thu, 12 Nov 2015 11:26:05 +1100 Subject: [PATCH] Update Readme to include branch details. As Master is going to be used for code refactoring work (for a potential 3.0), the 2.0 branch has been created to separate bug fixes for the current code. --- README.markdown | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.markdown b/README.markdown index 7b2e3b36..dcee8303 100644 --- a/README.markdown +++ b/README.markdown @@ -10,6 +10,12 @@ HTML_CodeSniffer is released under a BSD-style licence. For more information, pl HTML_CodeSniffer comes with standards and sniffs that cover the three conformance levels of the W3C [Web Content Accessibility Guidelines (WCAG) 2.0](http://www.w3.org/TR/WCAG20), and the U.S. [Section 508](http://section508.gov/index.cfm?fuseAction=stdsdoc) legislation. +## I want to develop something using HTML_CodeSniffer - which branch should I use? + +The `master` branch is the main development branch. + +The `2.0` branch is the current stable branch. Builds of the Accessibility Auditor occur off this branch (starting from version 2.0.6). If you are developing a tool based off HTML_CodeSniffer, it's probably best to use the appropriate version tags, or pin your version of HTML_CodeSniffer to the `2.0` branch. + ## Contributing and reporting issues To report any issues with using HTML_CodeSniffer, please use the [HTML_CodeSniffer Issue Tracker](http://github.com/squizlabs/HTML_CodeSniffer/issues).