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

formatting

Browse Source
This commit is contained in:
Guy Bedford
2013-09-16 11:42:36 +02:00
parent 208b59331c
commit 08bfa6201f
1 changed files with 5 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -16
View File
@@ -5,36 +5,25 @@ Pull requests welcome!
While the registry is small enough, all registry entries are managed through Github, moderated by the registry maintainers. While the registry is small enough, all registry entries are managed through Github, moderated by the registry maintainers.
* The registry provides a mapping from a _unique registry name_ to a _target package_. * The registry provides a mapping from a _unique registry name_ to a _target package_:
```
"bootstrap": "github:twbs/bootstrap"
```
* For ease of reference, please ensure new names are added in the correct alphabetical location. * For ease of reference, please ensure new names are added in the correct alphabetical location.
* Currently the following SPDY-optimized _location services_ are available in the registry mapping: * Currently the following SPDY-optimized _location services_ are available in the registry mapping:
* Github: `github:author/repo` * Github: `github:author/repo`
* NPM: `npm:repo` * NPM: `npm:repo`
Additional locations are in planning for other servies, and third party locations can also be [submitted](). Additional locations are in planning for other servies, and third party locations can also be [submitted]().
* Versions numbers are automatically appended onto the end of the target name based on the [jspm version conventions]().
* 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]().
* An optional _main entry point_ can be specified by appending the syntax `#main-file-name`. For example: * An optional _main entry point_ can be specified by appending the syntax `#main-file-name`. For example:
`"jquery": "github:components/jquery#jquery"` `"jquery": "github:components/jquery#jquery"`
will map: will map:
* `jquery` -> `github:components/jquery/jquery` * `jquery` -> `github:components/jquery/jquery`
* `jquery/submodule` -> `github:components/jquery/submodule` * `jquery/submodule` -> `github:components/jquery/submodule`
It is simply a shorthand for specifying the main entry point when the package is requested directly by name. It is simply a shorthand for specifying the main entry point when the package is requested directly by name.
* Further customizations of package configurations for jspm should be provided in the package.json file * Further customizations of package configurations for jspm should be provided in the package.json file
for a package. If you do not have direct access to the source package, use a package override to provide this. for a package. If you do not have direct access to the source package, use a package override to provide this.
Package Overrides Package Overrides
--- ---