Skip to content
This repository was archived by the owner on Jun 27, 2019. It is now read-only.

Commit 31d3264

Browse files
committed
Extending readme.md
1 parent e1dce1a commit 31d3264

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

readme.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@
55
## Installation
66
Coming soon …
77

8-
## Usage
8+
## Getting Started
9+
1. In order to use PatternLab you need to initialize a PatternLab project with `patternlab init`. The CLI will ask you some setup question and scaffold your project based on it.
10+
2. Build your patterns use `patternlab build`. The PatternLab CLI will assume that the `patternlab-config.json` is in the project root. Othewise specify a custom path to config with `patternlab build --config path/to/config`
11+
3. To view your patterns in the browser run `patternlab serve` or again specify a custom config location `patternlab serve --config path/to/config`
12+
4. To export your patterns in the browser run `patternlab export` or again specify a custom config location `patternlab export --config path/to/config`
13+
14+
## API & Usage
915
```
1016
Usage: patternlab <cmd> [options]
1117
Commands:

0 commit comments

Comments
 (0)