Skip to content

Commit 753443f

Browse files
committed
Updated README.
1 parent 9f9ba2c commit 753443f

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,17 @@ patternfly-cli [command]
2626

2727
### Available Commands
2828

29-
- **`scaffold`**: Create a new project from a template.
30-
- **`codemod`**: Apply code modifications to your project.
31-
- **`run`**: Execute predefined project tasks.
29+
- **`create`**: Create a new project from the available templates.
30+
- **`update`**: Update your project to a newer version .
3231

33-
## Development
32+
33+
## Development / Installation
34+
35+
### Install Dependencies
36+
37+
```sh
38+
npm install
39+
```
3440

3541
### Build
3642

@@ -40,11 +46,12 @@ To build the project, run:
4046
npm run build
4147
```
4248

43-
### Test
49+
### Installing the cli
4450

45-
Currently, no tests are specified. You can add tests and run them using:
51+
After building the cli you can install the cli globally by running the following command:
4652

4753
```sh
48-
npm test
54+
npm install -g
4955
```
5056

57+
After that you can now execute the cli via ```patternfly-cli``` command in the terminal. We are currently in the process of moving this to npmjs once we this ready for v 1.0.0

0 commit comments

Comments
 (0)