Skip to content

Commit e2ab440

Browse files
committed
Docs: Update readme with point about funpack cli
1 parent a16815e commit e2ab440

2 files changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ npm install --save-dev funpack
2121
yarn add -D funpack
2222
```
2323

24-
2. Add `funpack` to your package.json like so:
24+
2. Add `funpack` to your package.json, for example like so:
2525

2626
```json
2727
// package.json
@@ -37,6 +37,26 @@ yarn add -D funpack
3737
}
3838
```
3939

40+
Settings are described under the [Settings](#settings) section.
41+
42+
3. Run the `funpack` cli.
43+
For example:
44+
45+
```json
46+
{
47+
...
48+
"scripts": {
49+
"prepackage": "tsc --noEmit",
50+
"package": "funpack"
51+
},
52+
...
53+
}
54+
```
55+
56+
The `funpack` cli accepts `--packageJsonPath` (defaults to directory of script execution so your main `package.json`) that accepts the path of the `package.json` that contains the funpack config.
57+
58+
### Settings
59+
4060
Each option inside `settings` is optional. Below you can view what exactly is needed in the funpack object as well as which settings are available.
4161

4262
[configSchema that represents the funpack config](./src/parts/parseConfig.ts)

example/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
{
2+
"scripts": {
3+
"prepackage": "tsc --noEmit",
4+
"package": "funpack"
5+
},
26
"funpack": {
37
"settings": {
48
"zip": true

0 commit comments

Comments
 (0)