mowen233/jspm-registry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme updates

Browse Source
This commit is contained in:
Guy Bedford
2013-09-16 11:31:05 +02:00
parent a99092aba6
commit 52941336ff
1 changed files with 22 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+22 -15
View File
@@ -7,10 +7,21 @@ While the registry is small enough, all registry entries are managed through Git
* The registry provides a mapping from a unique registry name (`jquery`), to a target package (`github:components/jquery` / `npm:jquery`).
* For ease of reference, please ensure new names are added in the correct alphabetical location.
* Currently the following SPDY-optimized `locations` are available in the registry mapping:
* Github: `github:jquery/jquery` -> `https://github.jspm.io/jquery/jquery.js`
* NPM: `npm:underscore` -> `https://npm.jspm.io/underscore.js`
In this way, any package on Github or NPM is available for reference in the jspm registry.
Additional locations are in planning for other servies. Anyone can provide a location service. To provide a new
location service, see the [location service guidelines](), then contact us directly to have your location service
included in jspm.
* An optional `main` entry point can be specified with `#main-file-name`. For example:
`"jquery": "github:components/jquery#jquery"
`"jquery": "github:components/jquery#jquery"`
will map:
* `jquery` -> `github:components/jquery/jquery`
@@ -18,16 +29,11 @@ While the registry is small enough, all registry entries are managed through Git
It is simply a shorthand for specifying the main entry point when the package is requested directly by name.
* Currently the following `locations` are available in the registry mapping:
* `github:*`: Maps to the Github service.
* `npm:*` : Maps to the NPM service.
In this way, any package on Github or NPM is available for reference in the jspm registry.
Additional locations are in planning for other servies. Anyone can provide a location service. To provide a new
location service, see the Location Service Guidelines, then contact us directly to have your location service
included in jspm.
* Versions numbers are automatically appended onto the end of the target name. For example:
`jquery@2.0` -> `github:components/jquery/jquery@2.0`
All location services are designed to work with these [jspm version conventions]().
Package Overrides
@@ -35,9 +41,10 @@ Package Overrides
The registry also provides a `package.json` override system.
All jspm package configuration options are specified in the `package.json` file for packages. The jspm `package.json`
extension properties are documented here. Often changes need to be made to packages one may not have maintainer access to.
In this case, submit the `package.json` as an override in this repo to override the `package.json` file jspm uses for a given package.
All jspm package configuration options are specified in the `package.json` file for packages, as described
in the [jspm package.json specification](). Often changes need to be made to packages one may not have maintainer
access to. In this case, submit the `package.json` as an override in this repo to override the `package.json`
file jspm uses for a given package.
The overrides are located in the `package-overrides` folder of this repo, with the folder format: