Skip to content

Commit c278bd6

Browse files
author
lo kesh
committed
docs(README): Installation instructions
1 parent e863075 commit c278bd6

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
1-
# `Angular utils library`
1+
# Angular 4+ Utilities
22

3-
[![Greenkeeper badge](https://badges.greenkeeper.io/nglibrary/utils.svg)](https://greenkeeper.io/)
3+
Directives
44

5-
Set of utilities for Angular 4+
5+
* [Control info directive](https://nglibrary.github.io/utils-documentation/control-info)
66

7-
# Quick Start
7+
...more to come soon!
88

9-
```bash
9+
### Install
1010

11+
```bash
1112
yarn add @nglibrary/utils
13+
```
14+
### Import in your app
15+
16+
```ts
17+
import { NgModule } from '@angular/core';
18+
import { AppComponent } from './app.component';
19+
20+
import { UtilsModule } from '@nglibrary/utils'; // <---
21+
22+
@NgModule({
23+
declarations: [ AppComponent ],
24+
imports: [
25+
UtilsModule.forRoot( /* global config */ ) // <---
26+
],
27+
providers: [],
28+
bootstrap: [AppComponent]
29+
})
30+
export class AppModule { }
1231

1332
```

0 commit comments

Comments
 (0)