Skip to content

Commit

Permalink
feat(api): polish, refactored APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
xmlking committed Mar 6, 2019
1 parent c7340b3 commit 98f3fa8
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 5 deletions.
26 changes: 23 additions & 3 deletions libs/utils/README.md
@@ -1,14 +1,26 @@
# Utils

### Install
## Install

```bash
npm i @ngx-starter-kit/utils
```

### Usage
## Usage

### Publish
## Code scaffolding

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`.

> Note: Don't forget to add `--project utils` or else it will be added to the default project in your `angular.json` file.
## Build

Run `ng build utils` to build the project. The build artifacts will be stored in the `dist/` directory.

## Publishing

After building your library with `ng build utils`, go to the dist folder `cd dist/utils` and run `npm publish`.

```bash
# build
Expand All @@ -18,3 +30,11 @@ export NPM_TOKEN="00000000-0000-0000-0000-000000000000"
# publish
npm publish dist/libs/utils --access public
```

## Running unit tests

Run `ng test utils` to execute the unit tests via [Jest](https://jestjs.io/).

## Further help

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).
4 changes: 2 additions & 2 deletions libs/utils/package.json
Expand Up @@ -2,7 +2,7 @@
"name": "@ngx-starter-kit/utils",
"version": "0.0.1",
"peerDependencies": {
"@angular/common": "^7.2.0-rc.0",
"@angular/core": "^7.2.0-rc.0"
"@angular/common": "^7.2.0",
"@angular/core": "^7.2.0"
}
}

0 comments on commit 98f3fa8

Please sign in to comment.