From 208b59331c981097183aa06681609af590956ad5 Mon Sep 17 00:00:00 2001 From: Guy Bedford Date: Mon, 16 Sep 2013 11:40:31 +0200 Subject: [PATCH] readme clarifications --- README.md | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e5c6ddc..3f09660 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,22 @@ Pull requests welcome! 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 (`jquery`), to a target package (`github:components/jquery` / `npm:jquery`). +* The registry provides a mapping from a _unique registry name_ to a _target package_. * 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: +* Currently the following SPDY-optimized _location services_ 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` + * Github: `github:author/repo` + * NPM: `npm:repo` - 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, and third party locations can also be [submitted](). - 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](). -* An optional `main` entry point can be specified with `#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"` @@ -29,22 +31,14 @@ 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. -* 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](). +* 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. 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, 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 registry provides a `package.json` override system for updating package configuration associated with jspm. The overrides are located in the `package-overrides` folder of this repo, with the folder format: @@ -52,6 +46,6 @@ The overrides are located in the `package-overrides` folder of this repo, with t Only exact semver versions can be used, excluding semver build numbers and suffices. -For example, a package override for `jquery` would be located at: +For example, a package override for jquery 2.0.0 would be located at `package-overrides/github/jquery/jquery@2.0.0.json`. -`package-overrides/github/jquery/jquery@2.0.0.json` +Read more about customizing packages for jspm at the [jspm package.json specification]() page.