From 9cef134ec543a0ca47f7a9d5a8daccf8c22d6786 Mon Sep 17 00:00:00 2001 From: Morgan Roderick <20321+mroderick@users.noreply.github.com> Date: Mon, 24 Jun 2019 18:07:48 +0200 Subject: [PATCH] Create COMPATIBILITY.md (#2051) * Create COMPATIBILITY.md * Update README.md Co-Authored-By: Carl-Erik Kopseng --- COMPATIBILITY.md | 27 +++++++++++++++++++++++++++ CONTRIBUTING.md | 20 +------------------- README.md | 4 ++++ 3 files changed, 32 insertions(+), 19 deletions(-) create mode 100644 COMPATIBILITY.md diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md new file mode 100644 index 000000000..36f6396c0 --- /dev/null +++ b/COMPATIBILITY.md @@ -0,0 +1,27 @@ +# Compatibility + +This file is the canonical resource for compatibility goals for the libraries that make up Sinon.JS. + +## ES5.1 + +The source is written as [ES5.1][ES5] and requires no transpiler or polyfills. + +Sinon.JS uses feature detection to support [ES6][ES6] features, but does not rely on any of the new syntax introduced in [ES6][ES6] and remains compatible with [ES5.1][ES5] runtimes. + +## Runtimes + +Sinon.JS aims at supporting the following runtimes: + +* Firefox 45+ +* Chrome 48+ +* Internet Explorer 11+ +* Edge 14+ +* Safari 9+ +* Node LTS versions + +

+Sauce Test Status +

+ +[ES5]: http://www.ecma-international.org/ecma-262/5.1/ +[ES6]: http://www.ecma-international.org/ecma-262/6.0/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90f7d478f..ef0f92118 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,23 +65,7 @@ This will also install a pre-commit hook, that runs style validation on staged f ### Compatibility -#### ES5.1 - -Sinon's source is written as [ES5.1][ES5] and requires no transpiler or polyfills. - -Sinon.JS uses feature detection to support [ES6][ES6] features, but does not rely on any of the new syntax introduced in [ES6][ES6] and remains compatible with [ES5.1][ES5] runtimes. - -#### Runtimes - -Sinon.JS aims at supporting the following runtimes: - -* Firefox 45+ -* Chrome 48+ -* Internet Explorer 11+ -* Edge 14+ -* Safari 9+ -* Node LTS versions - +Please see [`COMPATIBILITY.md`][COMPATIBILITY.md] ### Linting and style @@ -137,5 +121,3 @@ To build simply run $ node build.js -[ES5]: http://www.ecma-international.org/ecma-262/5.1/ -[ES6]: http://www.ecma-international.org/ecma-262/6.0/ diff --git a/README.md b/README.md index be5dfa167..07cdc7252 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,10 @@ Sauce Test Status

+## Compatibility + +For details on compatibility and browser support, please see [`COMPATIBILITY.md`][COMPATIBILITY.md] + ## Installation via [npm](https://github.com/npm/npm)