From ccfd56f82ec62f5e0bbe40e3312a8adfc43df4f6 Mon Sep 17 00:00:00 2001 From: doktordirk Date: Sat, 2 Jul 2016 11:39:58 +0200 Subject: [PATCH] doc(installation): added --- doc/SUMMARY.md | 1 + doc/installation.md | 52 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 doc/installation.md diff --git a/doc/SUMMARY.md b/doc/SUMMARY.md index 005f564..203587c 100644 --- a/doc/SUMMARY.md +++ b/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) diff --git a/doc/installation.md b/doc/installation.md new file mode 100644 index 0000000..5d9034d --- /dev/null +++ b/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 +```