Skip to content

Commit e732db8

Browse files
authored
docs: rewrite README with clearer structure and usage instructions (#7)
1 parent b4da122 commit e732db8

1 file changed

Lines changed: 38 additions & 14 deletions

File tree

README.md

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,47 @@
1-
# Create Mobilewright
1+
# create-mobilewright
22

3-
Getting started with Mobilewright with a single "npm init" command
3+
Scaffold a [Mobilewright](https://mobilewright.dev) test project in seconds.
4+
5+
## Usage
46

57
```sh
68
npm init mobilewright
7-
# Or for Yarn
8-
yarn create mobilewright
9-
# Or for pnpm
10-
pnpm create mobilewright
119
```
1210

13-
Follow the instructions on screen to create a scaffold Mobilewright test project:
11+
Also works with Yarn (`yarn create mobilewright`) and pnpm (`pnpm create mobilewright`).
1412

15-
```text
16-
mobilewright.config.ts
17-
package.json
18-
package-lock.json
19-
tests/
20-
example.spec.ts
21-
```
13+
The CLI walks you through setup and creates a ready-to-run project:
2214

2315
![create-mobilewright screenshot](docs/screenshot.png)
16+
17+
## What you get
18+
19+
```
20+
my-project/
21+
mobilewright.config.ts # Device and app configuration
22+
tests/
23+
example.spec.ts # A working test you can run immediately
24+
package.json
25+
```
26+
27+
## Run your first test
28+
29+
```sh
30+
cd my-project
31+
npx mobilewright test
32+
```
33+
34+
That's it.
35+
36+
If this is the first time you are running a test on iOS (simulator or real device), you will need to run `npx mobilewright install` to set up the agent on the device.
37+
38+
If something's missing, `npx mobilewright doctor` tells you exactly what to fix.
39+
40+
## Next steps
41+
42+
- [Mobilewright docs](https://mobilewright.dev/docs) — API reference and guides
43+
- [mobile-use.com](https://mobile-use.com) — Run tests on real devices in the cloud
44+
45+
## License
46+
47+
Apache

0 commit comments

Comments
 (0)