Skip to content

Commit c5279e0

Browse files
docs(README.md): skeleton library
1 parent 2cdf041 commit c5279e0

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,7 @@ Guard
176176
----
177177

178178
* [Installation](#installation)
179+
* [Skeleton](#skeleton)
179180
* [Callback](#callback)
180181
* [Check](#check)
181182
* [typeOf](#typeof)
@@ -207,6 +208,24 @@ Install `@angular-package/type` package with command:
207208
npm i --save @angular-package/type
208209
```
209210

211+
## Skeleton
212+
213+
This project was build with the library[skeleton](https://github.com/angular-package/skeleton), it's just simple generated by angular-cli library with the command
214+
215+
```bash
216+
ng new skeleton --create-application=false
217+
```
218+
219+
Simply, copy this package to the folder of skeleton library `packages/type` then you can run commands below.
220+
221+
### Build
222+
223+
Run `ng build type` to build the project. The build artifacts will be stored in the `dist/` directory.
224+
225+
### Running unit tests
226+
227+
Run `ng test type` to execute the unit tests via [Karma](https://karma-runner.github.io).
228+
210229
## Callback
211230

212231
Default function to handle `callback` of [`ResultCallback`][resultcallback] type.

0 commit comments

Comments
 (0)