diff --git a/scripts/README.md b/scripts/README.md index 1c34d0a091..272ebfd667 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -4,6 +4,15 @@ All of these commands require you to run `npm install` first. Add the `--typecheck` flag to generate type definitions (`.d.ts`) and do type checking, but keep in mind builds and rebuilds when watching will be significantly slower (~1min and ~1s respectively, vs ~20s and ~200ms without typechecking). +### Installing Nightly Version + +The latest nightly version can be installed via npm. + +1. Run `npm install --save ionic-angular@nightly` +2. Your `package.json` file's `dependencies` will be updated with the nightly version. +3. Restart any `watch` or `serve` commands that may be already running. + + ### Building Ionic Source Run `gulp build` or `gulp watch` to watch for changes. @@ -42,14 +51,6 @@ From your app directory: To remove the linked version of `ionic-angular` do `npm rm ionic-angular`, and then reinstall using `npm install ionic-angular`. -### Publish a nightly release -1. Run `gulp publish.nightly` - - Pulls latest - - builds npm package files into dist - - updates package.json to a nightly version for publish: 0.1.0-beta.0 results in 0.1.0-beta.0-r8e7684t - - publishes to NPM using the nightly tag -2. `npm install ionic-angular@nightly` will now install the latest nightly release - ### Running Snapshot @@ -84,6 +85,15 @@ To remove the linked version of `ionic-angular` do `npm rm ionic-angular`, and t 6. Sit back and have a beer :beer: (or wine :wine_glass:) +### Publish a nightly release +1. Run `gulp publish.nightly` + - Pulls latest + - builds npm package files into dist + - updates package.json to a nightly version for publish: 0.1.0-beta.0 results in 0.1.0-beta.0-r8e7684t + - publishes to NPM using the nightly tag +2. `npm install ionic-angular@nightly` will now install the latest nightly release + + ### Releasing Component Demos (Copied from [ionic-preview-app](https://github.com/driftyco/ionic-preview-app#updating-ionic-site), check there for updates)