diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f6547c56..e4373785f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -129,4 +129,4 @@ This will only run the "css" module tests. This will significantly speed up your Remember that jQuery supports multiple browsers and their versions; any contributed code must work in all of them. You can refer to the [browser support page](http://jquery.com/browser-support/) for the current list of supported browsers. -Note that browser support differs depending on whether you are targeting the `master` or `compat` branch. +Note that browser support differs depending on whether you are targeting the `master` or `1.x` branch. diff --git a/README.md b/README.md index 71c015f78..b6ad406cd 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ In the spirit of open source software development, jQuery always encourages comm Environments in which to use jQuery -------------------------------------- -- [Browser support](http://jquery.com/browser-support/) differs between the master branch and the compat branch. Specifically, the master branch does not support legacy browsers such as IE8. The jQuery team continues to provide support for legacy browsers on the compat branch. Use the latest compat release if support for those browsers is required. See [browser support](http://jquery.com/browser-support/) for more info. -- To use jQuery in Node, browser extensions, and other non-browser environments, use only master branch releases given the name "jquery" rather than "jquery-compat". The compat branch does not support these environments. +- [Browser support](http://jquery.com/browser-support/) differs between the master branch and the 1.x branch. Specifically, the master branch does not support legacy browsers such as IE6-8. The jQuery team continues to provide support for legacy browsers on the 1.x branch. Use the latest 1.x release if support for those browsers is required. See [browser support](http://jquery.com/browser-support/) for more info. +- To use jQuery in Node, browser extensions, and other non-browser environments, use only master branch releases (2.x). The 1.x branch does not support these environments. What you need to build your own jQuery @@ -102,7 +102,7 @@ As a special case, you may also replace Sizzle by using a special flag `grunt cu *Note*: Excluding Sizzle will also exclude all jQuery selector extensions (such as `effects/animatedSelector` and `css/hiddenVisibleSelectors`). -*Note*: Removing Sizzle is not supported on the `compat` branch. +*Note*: Removing Sizzle is not supported on the `1.x` branch. The build process shows a message for each dependent module it excludes or includes. @@ -128,7 +128,7 @@ To create a custom build, first check out the version: git pull; git checkout VERSION ``` -Where VERSION is the version you want to customize. Then, make sure all Node dependencies are installed: +where VERSION is the version you want to customize. Then, make sure all Node dependencies are installed: ```bash npm install @@ -154,7 +154,7 @@ Exclude a bunch of modules: grunt custom:-ajax,-css,-deprecated,-dimensions,-effects,-event/alias,-offset,-wrap ``` -For questions or requests regarding custom builds, please start a thread on the [Developing jQuery Core](https://forum.jquery.com/developing-jquery-core) section of the forum. Due to the combinatorics and custom nature of these builds, they are not regularly tested in jQuery's unit test process. The non-Sizzle selector engine currently does not pass unit tests because it is missing too much essential functionality. +For questions or requests regarding custom builds, please start a thread on the [Developing jQuery Core](https://forum.jquery.com/developing-jquery-core) section of the forum. Due to the combinatorics and custom nature of these builds, they are not regularly tested in jQuery's unit test process. Running the Unit Tests -------------------------------------- @@ -261,7 +261,7 @@ start(); ``` -*Note*: QUnit's eventual addition of an argument to stop/start is ignored in this test suite so that start and stop can be passed as callbacks without worrying about their parameters. +Note: QUnit's eventual addition of an argument to stop/start is ignored in this test suite so that start and stop can be passed as callbacks without worrying about their parameters ### Test assertions ###