aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTimmy Willison <timmywillisn@gmail.com>2013-12-19 15:31:36 -0500
committerTimmy Willison <timmywillisn@gmail.com>2013-12-19 15:31:36 -0500
commit7e8a91c205723f11cd00c8834f348a649ab15926 (patch)
tree0ee62a134fbcc6bfbbae430c9f281658de925391 /README.md
parenta6f474e699f95a90f95228bd525490151acc0451 (diff)
downloadjquery-7e8a91c205723f11cd00c8834f348a649ab15926.tar.gz
jquery-7e8a91c205723f11cd00c8834f348a649ab15926.zip
Build: add build option for setting the AMD name.
Fixes #14016.
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 19 insertions, 3 deletions
diff --git a/README.md b/README.md
index ba18b77f9..ebc9de262 100644
--- a/README.md
+++ b/README.md
@@ -83,10 +83,10 @@ Some example modules that can be excluded are:
- **event/alias**: All event attaching/triggering shorthands like `.click()` or `.mouseover()`.
- **offset**: The `.offset()`, `.position()`, `.offsetParent()`, `.scrollLeft()`, and `.scrollTop()` methods.
- **wrap**: The `.wrap()`, `.wrapAll()`, `.wrapInner()`, and `.unwrap()` methods.
-- **exports/amd**: Exclude the AMD definition.
-- **exports/global**: Exclude the attachment of global jQuery variables ($ and jQuery) to the window.
- **core/ready**: Exclude the ready module if you place your scripts at the end of the body. Any ready callbacks bound with `jQuery()` will simply be called immediately. However, `jQuery(document).ready()` will not be a function and `.on("ready", ...)` or similar will not be triggered.
- **deferred**: Exclude jQuery.Deferred. This also removes jQuery.Callbacks. *Note* that modules that depend on jQuery.Deferred(AJAX, effects, core/ready) will not be removed and will still expect jQuery.Deferred to be there. Include your own jQuery.Deferred implementation or exclude those modules as well (`grunt custom:-deferred,-ajax,-effects,-core/ready`).
+- **exports/global**: Exclude the attachment of global jQuery variables ($ and jQuery) to the window.
+- **exports/amd**: Exclude the AMD definition.
As a special case, you may also replace Sizzle by using a special flag `grunt custom:-sizzle`.
@@ -96,6 +96,22 @@ As a special case, you may also replace Sizzle by using a special flag `grunt cu
The build process shows a message for each dependent module it excludes or includes.
+##### AMD name
+
+As an option, you can set the module name for jQuery's AMD definition. By default, it is set to "jquery", which plays nicely with plugins and third-party libraries, but there may be cases where you'd like to change this. Simply set the `"amd"` option:
+
+```bash
+grunt custom --amd="custom-name"
+```
+
+Or, to define anonymously, set the name to an empty string.
+
+```bash
+grunt custom --amd=""
+```
+
+#### Custom Build Examples
+
To create a custom build of the latest stable version, first check out the version:
```bash
@@ -108,7 +124,7 @@ Then, make sure all Node dependencies are installed:
npm install
```
-Create the custom build, use the `grunt custom` option, listing the modules to be excluded. Examples:
+Create the custom build using the `grunt custom` option, listing the modules to be excluded.
Exclude all **ajax** functionality: