Add documentation for the new react/v16 ruleset

strvcom · Oct 17, 2017 · cac39b0 · cac39b0
1 parent 71119ac
commit cac39b0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -52,6 +52,7 @@ See the [tutorial](tutorial) directory for lots of example config files.
 
 #### For [React][react-home]
 
+- @strv/javascript/environments/react/v16
 - @strv/javascript/environments/react/v15
 - @strv/javascript/environments/react/optional
 - @strv/javascript/environments/react/accessibility

diff --git a/environments/react/README.md b/environments/react/README.md
@@ -6,6 +6,10 @@ These configuration files are suitable to lint React components.
 
 ## Configurations
 
+### @strv/javascript/environments/react/v16
+
+Suitable for React v16. This ruleset builds on the react/v15 ruleset documented below and bumps the React version to 16 in the plugin configuration, causing some rules to recognise React 16-specific programming patterns.
+
 ### @strv/javascript/environments/react/v15
 
 Suitable for React v15. This ruleset configures ESLint to recognise JSX syntax and enables some rules that make the linting process more natural. Some accesssibility rules are also included to keep users happy even if they are using screen readers, braile devices or just keyboard.