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

Commit

Permalink
doc(installation): added
Browse files Browse the repository at this point in the history
  • Loading branch information
doktordirk committed Jul 2, 2016
1 parent bdb22da commit ccfd56f
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/SUMMARY.md
@@ -1,6 +1,7 @@
# Summary

* [Introduction](README.md)
* [Installation](installation.md)
* [Quick start](Quick start.md)
* [Configuration](configuration.md)
* [Usage](usage.md)
Expand Down
52 changes: 52 additions & 0 deletions doc/installation.md
@@ -0,0 +1,52 @@
# Installation

## Aureli-Cli

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
```

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
```

## Webpack

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

## Typescript

Add to your `typings.json`

```js
"aurelia-api": "github:spoonx/aurelia-api",
```

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
```

0 comments on commit ccfd56f

Please sign in to comment.