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

Commit

Permalink
Documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
Douglas Ludlow committed Sep 27, 2017
1 parent 55960ef commit 2397028
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand All @@ -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 ]
Expand Down Expand Up @@ -163,7 +169,7 @@ Feel free to request more.
</bs-modal>
```

![Example](demo/images/modal.png)
![Example](src/demo/assets/modal.png)

### Static modal

Expand Down Expand Up @@ -198,7 +204,7 @@ This will create a modal that cannot be closed with the escape key or by clickin
</bs-modal>
```

![Example](demo/images/modal-custom-footer.png)
![Example](src/demo/assets/modal-custom-footer.png)

### Opening and closing the modal from a parent component

Expand Down Expand Up @@ -377,27 +383,27 @@ 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.

## Testing

```bash
npm test
yarn test
```

To have karma to watch for changes:
```bash
npm run test:w
yarn test:w
```

## Bugs/Contributions
Expand Down

0 comments on commit 2397028

Please sign in to comment.