2013-09-16 11:23:44 +02:00
jspm Registry
---
Pull requests welcome!
While the registry is small enough, all registry entries are managed through Github, moderated by the registry maintainers.
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-09-16 11:42:36 +02:00
```
"bootstrap": "github:twbs/bootstrap"
` ``
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-16 11:45:09 +02:00
Additional locations are in planning for other services, and third party locations can also be [submitted]().
2013-09-16 11:44:22 +02:00
* Version numbers are automatically appended onto the end of the target name based on the [jspm version conventions]().
2013-09-16 11:40:31 +02:00
* An optional _main entry point_ can be specified by appending the syntax ` #main -file-name`. For example:
2013-09-16 11:31:05 +02:00
` "jquery": "github:components/jquery#jquery "`
2013-09-16 11:23:44 +02:00
will map:
* ` jquery` -> ` github:components/jquery/jquery`
* ` jquery/submodule` -> ` github:components/jquery/submodule`
2013-09-16 11:43:35 +02:00
2013-09-16 11:23:44 +02:00
It is simply a shorthand for specifying the main entry point when the package is requested directly by name.
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`
Only exact semver versions can be used, excluding semver build numbers and suffices.
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.
