Skip to content

Commit ee198c5

Browse files
docs: add dev instructions to readme
1 parent e28d807 commit ee198c5

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Fusing Angular CLI
22

3+
_Faster CLI tool for Angular_
4+
35
[![CircleCI](https://circleci.com/gh/patrickmichalina/fusing-angular-cli.svg?style=shield)](https://circleci.com/gh/patrickmichalina/fusing-angular-cli)
46
[![Greenkeeper badge](https://badges.greenkeeper.io/patrickmichalina/fusing-angular-cli.svg)](https://greenkeeper.io/)
57
[![dependencies Status](https://david-dm.org/patrickmichalina/fusing-angular-cli/status.svg)](https://david-dm.org/patrickmichalina/fusing-angular-cli)
68
[![devDependencies Status](https://david-dm.org/patrickmichalina/fusing-angular-cli/dev-status.svg)](https://david-dm.org/patrickmichalina/fusing-angular-cli?type=dev)
79
[![Fusebox-bundler](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/fusing-angular-cli/Lobby)
810

9-
WARNING: WORK IN PROGRESS
11+
**WARNING: WORK IN PROGRESS**
1012

1113
## Prerequisites
1214

@@ -17,6 +19,8 @@ The CLI has dependencies that require Node 10.0.0 or higher, together with NPM 6
1719
* [Installation](#installation)
1820
* [Usage](#usage)
1921
* [Updating Fusing Angular CLI](#updating-fusing-angular-cli)
22+
* [Developing Fusing Angular CLI](#developing-fusing-angular-cli)
23+
* [License](#license)
2024

2125
## Installation
2226

@@ -35,3 +39,29 @@ fng help
3539
```bash
3640
npm i -g fusing-angular-cli@latest
3741
```
42+
43+
## Developing Fusing Angular CLI
44+
45+
### Bundling and runnng the code
46+
47+
```bash
48+
# to run local CLI
49+
$ npm start
50+
51+
# to run local CLI w/ continuous testing
52+
$ npm run start.dev
53+
54+
# issuing CLI commands to local build
55+
$ .build/fng [some commands go here]
56+
```
57+
58+
### Testing your code
59+
60+
```bash
61+
# test your code
62+
npm test
63+
```
64+
65+
## License
66+
67+
MIT

0 commit comments

Comments
 (0)