Docs: Update the README of the published package

The previous details were showing their age, e.g. mentions about browsers
not supporting ES2015. The story with ES modules is more complex as it's also
about loaders but to keep the README simple, let's just make it more up to date
with typical usage.

Closes gh-5108

(cherry picked from commit edccabf10d)
This commit is contained in:
Michał Gołębiowski-Owczarek 2022-10-03 22:55:49 +02:00
parent 965391ab93
commit 76edd26ebb

View File

@ -19,17 +19,15 @@ Below are some of the most common ways to include jQuery.
<script src="https://code.jquery.com/jquery-@VERSION.min.js"></script> <script src="https://code.jquery.com/jquery-@VERSION.min.js"></script>
``` ```
#### Babel #### Webpack / Browserify / Babel
[Babel](https://babeljs.io/) is a next generation JavaScript compiler. One of the features is the ability to use ES6/ES2015 modules now, even though browsers do not yet support this feature natively. There are several ways to use [Webpack](https://webpack.js.org/), [Browserify](http://browserify.org/) or [Babel](https://babeljs.io/). For more information on using these tools, please refer to the corresponding project's documentation. In the script, including jQuery will usually look like this:
```js ```js
import $ from "jquery"; import $ from "jquery";
``` ```
#### Browserify/Webpack If you need to use jQuery in a file that's not an ECMAScript module, you can use the CommonJS syntax:
There are several ways to use [Browserify](http://browserify.org/) and [Webpack](https://webpack.js.org/). For more information on using these tools, please refer to the corresponding project's documentation. In the script, including jQuery will usually look like this...
```js ```js
var $ = require( "jquery" ); var $ = require( "jquery" );