From 2397028b63fc4a35ba0040f9f6d62d50fc4b24f1 Mon Sep 17 00:00:00 2001 From: Douglas Ludlow Date: Wed, 27 Sep 2017 06:08:27 -0600 Subject: [PATCH] Documentation updates. --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9ee1b13..9f77a69 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,16 @@ If you're using Typescript in your project, `ng2-bs3-modal` requires Typescript ## Install +npm ```bash npm install --save ng2-bs3-modal ``` +yarn +```bash +yarn add ng2-bs3-modal +``` + Then include the `ng2-bs3-modal` in your project. Using [SystemJS](https://github.com/systemjs/systemjs), you can add a mapping to your `System.config`: @@ -46,7 +52,7 @@ Then include the module in the `imports` collection of your app's module: ```typescript import { NgModule } from '@angular/core'; -import { Ng2Bs3ModalModule } from 'ng2-bs3-modal/ng2-bs3-modal'; +import { BsModalModule } from 'ng2-bs3-modal/ng2-bs3-modal'; @NgModule({ imports: [ BsModalModule ] @@ -163,7 +169,7 @@ Feel free to request more. ``` -![Example](demo/images/modal.png) +![Example](src/demo/assets/modal.png) ### Static modal @@ -198,7 +204,7 @@ This will create a modal that cannot be closed with the escape key or by clickin ``` -![Example](demo/images/modal-custom-footer.png) +![Example](src/demo/assets/modal-custom-footer.png) ### Opening and closing the modal from a parent component @@ -377,14 +383,14 @@ Note: If you are updating items asynchronously, make sure you are using `trackBy ```bash git clone https://github.com/dougludlow/ng2-bs3-modal.git -npm install -npm run build +yarn +yarn build ``` ## Running ```bash -npm start +yarn start ``` Navigate to http://127.0.0.1:8080 in your browser. @@ -392,12 +398,12 @@ Navigate to http://127.0.0.1:8080 in your browser. ## Testing ```bash -npm test +yarn test ``` To have karma to watch for changes: ```bash -npm run test:w +yarn test:w ``` ## Bugs/Contributions