-
-
Notifications
You must be signed in to change notification settings - Fork 272
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f63f5bc
commit 5ce4298
Showing
1 changed file
with
9 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,20 +10,21 @@ https://jspm.io | |
|
||
[Build into a bundle](#1-creating-a-bundle) or [inject a flat dependency tree for flat multiplexing](#2-creating-a-dependency-cache) in production. | ||
|
||
Use `jspm --help` to see the full up-to-date list of commands. | ||
|
||
### Example | ||
|
||
``` | ||
jspm install npm:voxel-demo | ||
Package.json file does not exist, create it? [yes]: | ||
Would you like jspm to prefix the jspm package.json properties under jspm? [yes]: | ||
Enter a name for the project (optional): | ||
Enter baseURL path [.]: | ||
Enter project source folder [./lib]: | ||
Enter project built folder (optional): | ||
Enter packages folder [./jspm_packages]: | ||
Enter config file path [./config.js]: | ||
Configuration file config.js doesn't exist, create it? [yes]: | ||
Configuration file config.js doesn't exist, create it? [yes]: | ||
Looking up npm:voxel-demo | ||
Updating registry cache... | ||
|
@@ -51,7 +52,7 @@ We can load this demo with: | |
<script src="jspm_packages/system.js"></script> | ||
<script src="config.js"></script> | ||
<script> | ||
System.import('npm:voxel-demo'); | ||
System.import('voxel-demo'); | ||
</script> | ||
``` | ||
|
||
|
@@ -70,15 +71,14 @@ We can load this demo with: | |
cd my-project | ||
jspm init | ||
Package.json file does not exist, create it? [yes]: | ||
Would you like jspm to prefix the jspm package.json properties under jspm? [yes]: | ||
Enter a name for the project (optional): | ||
Enter baseURL path [.]: | ||
Enter project source folder [./lib]: | ||
Enter project built folder (optional): | ||
Enter packages folder [./jspm_packages]: | ||
Enter config file path [./config.js]: | ||
Configuration file config.js doesn't exist, create it? [yes]: | ||
Configuration file config.js doesn't exist, create it? [yes]: | ||
ok Verified package.json at package.json | ||
Verified config file at config.js | ||
|
@@ -121,7 +121,7 @@ We can load this demo with: | |
|
||
lib/app.js | ||
```javascript | ||
var _ = require('npm:lodash-node/modern/objects/isEqual'); | ||
var _ = require('lodash-node/modern/objects/isEqual'); | ||
var $ = require('jquery'); | ||
var underscore = require('myname'); | ||
|
||
|
@@ -164,7 +164,7 @@ Automatically downloads and sets the configuration map for the loader. | |
This is equivalent to writing: | ||
|
||
``` | ||
jspm install jquery=github:components/jquery | ||
jspm install github:components/jquery | ||
``` | ||
|
||
The [jspm registry](https://github.com/jspm/registry) just provides a mapping from a name into an endpoint package name. | ||
|
@@ -240,6 +240,8 @@ ok Package linked. | |
`my-jspm-app` gets a symlink to a globally linked version of `my-local-package`. But changes to `my-local-package` do require | ||
running `jspm link npm:[email protected]` again to update the link cache, as jspm runs build operations on the package when adding npm compatibility. | ||
|
||
To reinstall from origin a linked package, use `jspm install --unlink`. | ||
|
||
### Creating Custom Endpoints | ||
|
||
You may wish to create your own custom endpoints, such as a private `npm` repo. | ||
|