Skip to content

Commit 98f3fa8

Browse files
committed
feat(api): polish, refactored APIs
1 parent c7340b3 commit 98f3fa8

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

libs/utils/README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11
# Utils
22

3-
### Install
3+
## Install
44

55
```bash
66
npm i @ngx-starter-kit/utils
77
```
88

9-
### Usage
9+
## Usage
1010

11-
### Publish
11+
## Code scaffolding
12+
13+
Run `ng generate component component-name --project utils` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project utils`.
14+
15+
> Note: Don't forget to add `--project utils` or else it will be added to the default project in your `angular.json` file.
16+
17+
## Build
18+
19+
Run `ng build utils` to build the project. The build artifacts will be stored in the `dist/` directory.
20+
21+
## Publishing
22+
23+
After building your library with `ng build utils`, go to the dist folder `cd dist/utils` and run `npm publish`.
1224

1325
```bash
1426
# build
@@ -18,3 +30,11 @@ export NPM_TOKEN="00000000-0000-0000-0000-000000000000"
1830
# publish
1931
npm publish dist/libs/utils --access public
2032
```
33+
34+
## Running unit tests
35+
36+
Run `ng test utils` to execute the unit tests via [Jest](https://jestjs.io/).
37+
38+
## Further help
39+
40+
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).

libs/utils/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@ngx-starter-kit/utils",
33
"version": "0.0.1",
44
"peerDependencies": {
5-
"@angular/common": "^7.2.0-rc.0",
6-
"@angular/core": "^7.2.0-rc.0"
5+
"@angular/common": "^7.2.0",
6+
"@angular/core": "^7.2.0"
77
}
88
}

0 commit comments

Comments
 (0)