Skip to content

Commit 1728611

Browse files
authored
Merge pull request #17 from tobi-or-not/patch-1
Update readme.md
2 parents ec072ee + 5d38012 commit 1728611

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

readme.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,21 @@ The webpack wrapper around [Pattern Lab Node Core](https://github.com/pattern-la
66

77

88

9-
## Installation and Starting
10-
11-
1. `npm install`
12-
2. `npm run patternlab:serve`
9+
## Quickstart Guide
10+
*If you do not have nodejs installed, please check the **Prerequisites** section*
11+
12+
13+
1. Download or clone this repository
14+
Example: `git clone [email protected]:Comcast/patternlab-edition-node-webpack.git`
15+
2. In a terminal window, navigate to the downloaded directory
16+
Example: `cd path/to/patternlab-edition-node-webpack`
17+
3. To populate Patternlab with sample data, install a starter kit
18+
Run `npm install starterkit-mustache-demo`
19+
There are other [starterkits](https://github.com/pattern-lab?utf8=%E2%9C%93&q=starterkit&type=&language=) available
20+
4. Generate sample files
21+
Run: `npm run patternlab:loadstarterkit --kit=starterkit-mustache-demo`
22+
5. Show Patternlab in a Webbrowser
23+
Run: `npm run patternlab:serve`
1324

1425

1526
## Packaged Components

0 commit comments

Comments
 (0)