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

Commit df3602a

Browse files
committed
Updating readme.md. Fixes #21, fixes #22
1 parent 8b7831b commit df3602a

File tree

3 files changed

+53
-4
lines changed

3 files changed

+53
-4
lines changed

bin/inquiries/starterkit.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ const starterkitSetup = [{
5252
value: false
5353
}],
5454
default: {
55-
name: 'starterkit-mustache-base',
55+
name: 'starterkit-mustache-demo',
5656
value: 'starterkit-mustache-demo'}
5757
}];
5858
module.exports = starterkitSetup;

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"inquirer": "2.0.0",
2222
"lodash": "4.17.4",
2323
"path-exists": "3.0.0",
24-
"patternlab-node": " 2.7.1",
24+
"patternlab-node": " 2.7.2",
2525
"sanitize-filename": "1.6.1"
2626
},
2727
"devDependencies": {

readme.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
4. To export your patterns in the browser preview `patternlab export` or again specify a custom config location `patternlab export --config path/to/config`
1616

1717
## API & Usage
18+
### General usage
1819
```
1920
Usage: patternlab <cmd> [options]
2021
Commands:
@@ -23,11 +24,59 @@ Usage: patternlab <cmd> [options]
2324
init [options] Initialize a PatternLab project from scratch or import an edition and/or starterkit
2425
serve|browse Starts a server to inspect files in browser
2526
27+
Options:
28+
-h, --help output usage information
29+
-V, --version output the version number
30+
-c, --config <path> Specify config file. Default looks up the project dir
31+
-v, --verbose Show verbose logging
32+
```
33+
34+
### Build/Compile PatternLab
35+
```
36+
Usage: build|compile [options]
37+
38+
Build the PatternLab. Optionally (re-)build only the patterns
39+
40+
Options:
41+
-h, --help output usage information
42+
-p, --patterns-only Whether to only build patterns
43+
```
44+
45+
### Initialize PatternLab
46+
```
47+
Usage: init [options]
48+
49+
Initialize a PatternLab project from scratch or import an edition and/or starterkit
50+
Passing no options starts the init in interactive mode
51+
2652
Options:
2753
-h, --help output usage information
28-
-V, --version output the version number
29-
-c, --config <path> Specify config file. Default looks up the project dir
54+
-p, --project-dir <path> Specify a project directory. Default: ./
55+
-e, --edition <name> Specify an edition to install. Default: edition-node
56+
-k, --starterkit <name> Specify a starterkit to install. Default: starterkit-mustache-demo
57+
```
58+
59+
### Serve PatternLab
3060
```
61+
Usage: serve|browse [options]
62+
63+
Starts a server to inspect files in browser
64+
65+
66+
Options:
67+
-h, --help output usage information
68+
```
69+
70+
### Export PatternLab
71+
```
72+
Usage: export [options]
73+
74+
Export a PatternLab patterns into a compressed format
75+
76+
Options:
77+
-h, --help output usage information
78+
```
79+
3180
## Examples
3281
```
3382
$ patternlab init # Initialize a PatternLab project.

0 commit comments

Comments
 (0)