s/npmcdn/unpkg/
This commit is contained in:
Michael Jackson
@ -1,36 +1,36 @@
|
||||
npmcdn is a fast, global [content-delivery network](https://en.wikipedia.org/wiki/Content_delivery_network) for stuff that is published to [npm](https://www.npmjs.com/). Use it to quickly and easily load files using a simple URL like:
|
||||
unpkg is a fast, global [content-delivery network](https://en.wikipedia.org/wiki/Content_delivery_network) for stuff that is published to [npm](https://www.npmjs.com/). Use it to quickly and easily load files using a simple URL like:
|
||||
|
||||
<div style="text-align:center">`https://npmcdn.com/package@version/file`</div>
|
||||
<div style="text-align:center">`https://unpkg.com/package@version/file`</div>
|
||||
|
||||
A few examples:
|
||||
|
||||
* [https://npmcdn.com/react@15.0.1/dist/react.min.js](/react@15.0.1/dist/react.min.js)
|
||||
* [https://npmcdn.com/react-dom@15.0.1/dist/react-dom.min.js](/react-dom@15.0.1/dist/react-dom.min.js)
|
||||
* [https://npmcdn.com/history@1.12.5/umd/History.min.js](/history@1.12.5/umd/History.min.js)
|
||||
* [https://unpkg.com/react@15.0.1/dist/react.min.js](/react@15.0.1/dist/react.min.js)
|
||||
* [https://unpkg.com/react-dom@15.0.1/dist/react-dom.min.js](/react-dom@15.0.1/dist/react-dom.min.js)
|
||||
* [https://unpkg.com/history@1.12.5/umd/History.min.js](/history@1.12.5/umd/History.min.js)
|
||||
|
||||
You may also use a [tag](https://docs.npmjs.com/cli/dist-tag) or [version range](https://docs.npmjs.com/misc/semver) instead of a fixed version number, or omit the version/tag entirely to use the `latest` tag.
|
||||
|
||||
* [https://npmcdn.com/react@^0.14/dist/react.min.js](/react@^0.14/dist/react.min.js)
|
||||
* [https://npmcdn.com/react/dist/react.min.js](/react/dist/react.min.js)
|
||||
* [https://unpkg.com/react@^0.14/dist/react.min.js](/react@^0.14/dist/react.min.js)
|
||||
* [https://unpkg.com/react/dist/react.min.js](/react/dist/react.min.js)
|
||||
|
||||
If you omit the file path, npmcdn will try to serve [the `browser` bundle](https://github.com/defunctzombie/package-browser-field-spec) if present, the [`main` module](https://docs.npmjs.com/files/package.json#main) otherwise.
|
||||
If you omit the file path, unpkg will try to serve [the `browser` bundle](https://github.com/defunctzombie/package-browser-field-spec) if present, the [`main` module](https://docs.npmjs.com/files/package.json#main) otherwise.
|
||||
|
||||
* [https://npmcdn.com/jquery](/jquery)
|
||||
* [https://npmcdn.com/angular-formly](/angular-formly)
|
||||
* [https://npmcdn.com/three](/three)
|
||||
* [https://unpkg.com/jquery](/jquery)
|
||||
* [https://unpkg.com/angular-formly](/angular-formly)
|
||||
* [https://unpkg.com/three](/three)
|
||||
|
||||
Append a `/` at the end of a URL to view a listing of all the files in a package.
|
||||
|
||||
* [https://npmcdn.com/lodash/](/lodash/)
|
||||
* [https://npmcdn.com/modernizr/](/modernizr/)
|
||||
* [https://npmcdn.com/react/](/react/)
|
||||
* [https://unpkg.com/lodash/](/lodash/)
|
||||
* [https://unpkg.com/modernizr/](/modernizr/)
|
||||
* [https://unpkg.com/react/](/react/)
|
||||
|
||||
You may use the special `/bower.zip` file path in packages that contain a `bower.json` file to dynamically generate a zip file that Bower can use to install the package.
|
||||
|
||||
* [https://npmcdn.com/react-swap/bower.zip](/react-swap/bower.zip)
|
||||
* [https://npmcdn.com/react-collapse@1.6.3/bower.zip](/react-collapse@1.6.3/bower.zip)
|
||||
* [https://unpkg.com/react-swap/bower.zip](/react-swap/bower.zip)
|
||||
* [https://unpkg.com/react-collapse@1.6.3/bower.zip](/react-collapse@1.6.3/bower.zip)
|
||||
|
||||
**_We do NOT recommend JavaScript libraries use Bower._** Bower places additional burdens on JavaScript package authors for little to no gain. npmcdn is intended to make it easier to publish code, not harder, so Bower support will be removed in January 2017\. Please move to npm for installing packages and stop using Bower before that time. See [here](https://github.com/mjackson/npm-http-server#bower-support) for our rationale.
|
||||
**_We do NOT recommend JavaScript libraries use Bower._** Bower places additional burdens on JavaScript package authors for little to no gain. unpkg is intended to make it easier to publish code, not harder, so Bower support will be removed in January 2017\. Please move to npm for installing packages and stop using Bower before that time. See [here](https://github.com/mjackson/npm-http-server#bower-support) for our rationale.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
@ -58,7 +58,7 @@ You may use the special `/bower.zip` file path in packages that contain a `bower
|
||||
|
||||
### Suggested Workflow
|
||||
|
||||
For npm package authors, npmcdn relieves the burden of publishing your code to a CDN in addition to the npm registry. All you need to do is include your [UMD](https://github.com/umdjs/umd) build in your npm package (not your repo, that's different!).
|
||||
For npm package authors, unpkg relieves the burden of publishing your code to a CDN in addition to the npm registry. All you need to do is include your [UMD](https://github.com/umdjs/umd) build in your npm package (not your repo, that's different!).
|
||||
|
||||
You can do this easily using the following setup:
|
||||
|
||||
@ -66,4 +66,4 @@ You can do this easily using the following setup:
|
||||
* Add the `umd` directory to your [files array](https://docs.npmjs.com/files/package.json#files) in `package.json`
|
||||
* Use a build script to generate your UMD build in the `umd` directory when you publish
|
||||
|
||||
That's it! Now when you `npm publish` you'll have a version available on npmcdn as well.
|
||||
That's it! Now when you `npm publish` you'll have a version available on unpkg as well.
|
||||
|
||||
Reference in New Issue
Block a user