Skip to content

Commit d8d206f

Browse files
authored
docs: small tweaks (#113)
* docs: small tweaks * doc: use npx commands for the npm examples
1 parent 82ea99f commit d8d206f

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

docs/cli/building-the-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Before the app can be tested, it must be built.
2222
<TabItem value="npm" label="npm">
2323

2424
```bash
25-
npm run owl build -- --platform ios --config ./owl.config.json
25+
npx owl build --platform ios --config ./owl.config.json
2626
```
2727

2828
</TabItem>

docs/cli/testing-the-app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The baseline images will be automatically generated. To regenerate the baseline
4141
<TabItem value="npm" label="npm">
4242

4343
```bash
44-
npm run owl test -- --platform ios
44+
npx owl test --platform ios
4545
```
4646

4747
</TabItem>
@@ -62,7 +62,7 @@ Update the baseline images
6262
<TabItem value="npm" label="npm">
6363

6464
```bash
65-
npm run owl test -- --platform ios --update
65+
npx owl test --platform ios --update
6666
```
6767

6868
</TabItem>
@@ -83,7 +83,7 @@ Update the baseline images
8383
<TabItem value="npm" label="npm">
8484

8585
```bash
86-
npm run owl test -- --platform ios --config ./owl.config.json
86+
npx owl test --platform ios --config ./owl.config.json
8787
```
8888

8989
</TabItem>

docs/introduction/getting-started.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Below you can find an example config (can also be found in the [example app](htt
2828
},
2929
"android": {
3030
"packageName": "com.owldemo"
31-
},
31+
}
3232
}
3333
```
3434

@@ -47,9 +47,7 @@ describe('App.tsx', () => {
4747

4848
expect(screen).toMatchBaseline();
4949
});
50-
});
5150

52-
describe('App.tsx', () => {
5351
it('presses a button, then takes a screenshot', async () => {
5452
await press('button')
5553

@@ -68,7 +66,7 @@ Before the app can be tested, it must be built.
6866
<TabItem value="npm" label="npm">
6967

7068
```bash
71-
npm run owl build -- --platform ios
69+
npx owl build --platform ios
7270
```
7371

7472
</TabItem>
@@ -100,7 +98,7 @@ Test against the baseline images (will create the baseline images if they don't
10098
<TabItem value="npm" label="npm">
10199

102100
```bash
103-
npm run owl test -- --platform ios
101+
npx owl test --platform ios
104102
```
105103

106104
</TabItem>
@@ -119,7 +117,7 @@ Update the baseline images
119117
<TabItem value="npm" label="npm">
120118

121119
```bash
122-
npm run owl test -- --platform ios --update
120+
npx owl test --platform ios --update
123121
```
124122

125123
</TabItem>

0 commit comments

Comments
 (0)