Files
jspm-registry/README.md
T

39 lines
1.8 KiB
Markdown
Raw Normal View History

2013-09-27 10:16:16 +02:00
JSPM Registry
2013-09-16 11:23:44 +02:00
---
2013-11-12 16:59:12 +02:00
Pull requests welcome. View `registry.json` to see what is currently in the registry.
2013-09-16 11:23:44 +02:00
2013-09-27 10:16:16 +02:00
2013-11-12 16:59:12 +02:00
* The JSPM Registry is the default registryURL for the [JSPM loader](https://github.com/jspm/jspm-loader) located at `https://registry.jspm.io`.
2013-09-27 10:16:16 +02:00
2013-11-12 16:59:12 +02:00
* It simply provides a lookup from a name to a target endpoint:
```javascript
"bootstrap": "github:twbs/bootstrap"
```
2013-09-16 11:23:44 +02:00
2013-09-16 11:42:36 +02:00
* The registry provides a mapping from a _unique registry name_ to a _target package_:
2013-09-16 11:43:35 +02:00
2013-11-12 16:59:12 +02:00
2013-09-16 11:23:44 +02:00
* For ease of reference, please ensure new names are added in the correct alphabetical location.
2013-09-16 11:40:31 +02:00
* Currently the following SPDY-optimized _location services_ are available in the registry mapping:
* Github: `github:author/repo`
* NPM: `npm:repo`
2013-09-16 11:43:35 +02:00
2013-09-27 10:21:17 +02:00
Additional locations are in planning for other services, and third party locations can also be [submitted](https://github.com/jspm/jspm-loader#cdn-locations).
* Version numbers are automatically appended onto the end of the target name based on the [jspm version conventions](https://github.com/jspm/jspm-loader#cdn-locations).
2013-09-16 11:40:31 +02:00
* Further customizations of package configurations for jspm should be provided in the package.json file
2013-09-16 11:47:05 +02:00
for a package. If you do not have direct access to the source package, use a package.json override.
2013-09-16 11:23:44 +02:00
2013-09-16 11:47:05 +02:00
Package.json Overrides
2013-09-16 11:23:44 +02:00
---
2013-09-16 11:47:05 +02:00
The registry provides a package.json override system for updating package configuration associated with jspm.
2013-09-16 11:23:44 +02:00
The overrides are located in the `package-overrides` folder of this repo, with the folder format:
`package-overrides/[location-name]/[location-path]@[version].json`
2013-09-16 11:40:31 +02:00
For example, a package override for jquery 2.0.0 would be located at `package-overrides/github/jquery/jquery@2.0.0.json`.
2013-09-16 11:23:44 +02:00
2013-09-16 12:12:31 +02:00
Read more about customizing packages for jspm at the [jspm package.json specification](https://github.com/jspm/registry/wiki/Package.json-Specification) page.