UNPKG

3.17 kBMarkdownView Raw
1jspm CLI
2===
3
4[![NPM version][npm-image]][npm-url]
5[![Downloads][downloads-image]][npm-url]
6[![Travis build Status][travis-image]][travis-url]
7[![AppVeyor build Status][appveyor-image]][appveyor-url]
8[![Gitter][gitter-image]][gitter-url]
9[![Support][supporterhq-image]][supporterhq-url]
10[![Codecov][codecov-image]][codecov-url]
11
12Registry and format agnostic JavaScript package manager.
13
14* Supports installing any module format from any registry, with GitHub and npm currently provided, via [the registry API](docs/registry-api.md).
15* Couples to the [SystemJS module loader](https://github.com/systemjs/systemjs), which is built on the current draft of the [browser ES6 module loader](https://github.com/ModuleLoader/es6-module-loader) specification.
16* Carefully resolves version ranges using greedy fork minimization into flat multi-version package folders.
17* Provides tiered bundling of multi-format module trees using [SystemJS builder](https://github.com/systemjs/builder).
18* Loads and builds assets through [SystemJS plugins](https://github.com/systemjs/systemjs#plugins).
19
20See [https://jspm.io](https://jspm.io) for a project overview.
21
22For support, [join the Gitter room](https://gitter.im/jspm/jspm) or [Google Group](http://groups.google.com/group/jspm-io).
23
24Use `jspm --help` to see the full up-to-date list of commands.
25
26If you are interested in contributing to the project, [please read the contributors' guide](https://github.com/jspm/jspm-cli/wiki/Contributors%27-Guide).
27
28For a list of community projects and tools, see the [Third-Party Resources Wiki](https://github.com/jspm/jspm-cli/wiki/Third-Party-Resources).
29
30### Documentation
31
32See the [SystemJS](https://github.com/systemjs/systemjs) project page for SystemJS usage documentation.
33
34* [Getting Started with jspm](docs/getting-started.md)
35* [Installing Packages](docs/installing-packages.md)
36* [Plugins](docs/plugins.md)
37* [Production Workflows](docs/production-workflows.md)
38* [Publishing Packages](docs/publishing-packages.md)
39* [Registries](docs/registries.md)
40* [Linking](docs/linking.md)
41* [NodeJS Usage](docs/nodejs-usage.md)
42* [The Registry Property](docs/registry-property.md)
43* [jspm API](docs/api.md)
44* [Registry API](docs/registry-api.md)
45
46### License
47
48Apache 2.0
49
50[appveyor-url]: https://ci.appveyor.com/project/guybedford/jspm-cli
51[appveyor-image]: https://ci.appveyor.com/api/projects/status/gf1tr1gh4520hpcj?svg=true
52[downloads-image]: http://img.shields.io/npm/dm/jspm.svg
53[gitter-image]: https://badges.gitter.im/Join%20Chat.svg
54[gitter-url]: https://gitter.im/jspm/jspm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
55[npm-image]: http://img.shields.io/npm/v/jspm.svg
56[npm-url]: https://npmjs.org/package/jspm
57[supporterhq-image]: https://supporterhq.com/api/b/33df4abbec4d39260f49015d2457eafe/JSPM
58[supporterhq-url]: https://supporterhq.com/support/33df4abbec4d39260f49015d2457eafe/JSPM
59[travis-image]: https://travis-ci.org/jspm/jspm-cli.svg?branch=master
60[travis-url]: https://travis-ci.org/jspm/jspm-cli
61[codecov-image]: https://img.shields.io/codecov/c/github/jspm/jspm-cli/master.svg
62[codecov-url]: https://codecov.io/gh/jspm/jspm-cli/branch/master