Skip to content
This repository has been archived by the owner on Nov 25, 2020. It is now read-only.

Commit

Permalink
doc(readme): update install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
doktordirk committed Jul 2, 2016
1 parent 65dd197 commit bdb22da
Showing 1 changed file with 41 additions and 10 deletions.
51 changes: 41 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,55 @@ The [changelog](doc/changelog.md) provides you with information about important

## Installation

Run `jspm i aurelia-api`, or (for webpack) `npm i aurelia-api` from your project root.
### Aureli-Cli

If install breaks your application, try resolving jspm forks:
Run `npm i aurelia-api` from your project root and add `aurelia-api` to the `build/bundles/dependencies` section of `aurelia-project/aurelia.json`.

### Jspm

Run `jspm i aurelia-api`

If the installation results in having forks, try resolving them by running:

```sh
jspm inspect --forks
jspm resolve --only registry:package-name@version
```
$ jspm inspect --forks
$ jspm resolve --only registry:package-name@version

E.g.

```sh
jspm inspect --forks
> Installed Forks
> npm:aurelia-dependency-injection 1.0.0-beta.1.2.3 1.0.0-beta.2.1.0

jspm resolve --only npm:aurelia-dependency-injection@1.0.0-beta.2.1.0
```

E.g.
### Webpack

Run `npm i aurelia-api` from your project root.

### Typescript

Add to your `typings.json`

```js
"aurelia-api": "github:spoonx/aurelia-api",
```
$ jspm inspect --forks
Installed Forks

npm:aurelia-dependency-injection 1.0.0-beta.1.2.3 1.0.0-beta.2.1.0
$ jspm resolve --only npm:aurelia-dependency-injection@1.0.0-beta.2.1.0
and run `typings i`

or run

```sh
typings i github:spoonx/aurelia-api
```

Aurelia-api uses [extend](https://www.npmjs.com/package/extend). To get typings for extend run:

```sh
typings i dt~extend --global
```

## Usage
Expand Down

0 comments on commit bdb22da

Please sign in to comment.