Skip to content

Commit 0b50b79

Browse files
authored
chore: update readme
1 parent 56a7566 commit 0b50b79

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,41 @@
22

33
# webcontainer-ecosystem-ci
44

5-
This repository is used to run tests for WebContainer ecosystem projects
5+
This repository is used to run tests for WebContainer ecosystem projects.
66

7-
## Github workflow
7+
## GitHub workflow
88

99
### Scheduled
1010

11-
Workflows are sheduled to run automatically every Monday, Wednesday and Friday.
11+
Workflows are scheduled to run automatically every Monday, Wednesday and Friday.
1212

1313
### Manually
1414

15-
- open [workflow](../../actions/workflows/ecosystem-ci.yml)
16-
- click 'Run workflow' button on top right of the list
17-
- select suite to run in dropdown
18-
- start workflow
15+
- Open [workflow](../../actions/workflows/ecosystem-ci.yml)
16+
- Click the 'Run workflow' button at the top right of the list
17+
- Select the suite to run in the dropdown
18+
- Start the workflow
1919

2020
### Shell script
2121

22-
- clone this repo
23-
- run `pnpm i`
24-
- run `pnpm test` to run all suites
25-
- or `pnpm test <suitename>` to select a suite
26-
- or `tsx ecosystem-ci.ts`
22+
- Clone this repo
23+
- Run `pnpm i`
24+
- Run `pnpm test` to execute all suites
25+
- Or `pnpm test <suitename>` to select a specific suite
26+
- Or `tsx ecosystem-ci.ts`
2727

2828
You can pass `--release <version>` to select a specific `@webcontainer/api` version to use.
2929

30-
The repositories are checked out into `workspace` subdirectory as shallow clones
30+
The repositories are checked out into the `workspace` subdirectory as shallow clones.
3131

3232
## How to add a new integration test
3333

34-
- check out the existing [tests](./tests) and add one yourself. Thanks to some utilities it is really easy
35-
- once you are confidente the suite works, add it to the lists of suites in the [workflows](../../actions/)
34+
- Check out the existing [tests](./tests) and add one yourself. Thanks to some utilities, it is really easy
35+
- Once you are confidente the suite works, add it to the lists of suites in the [workflows](../../actions/)
3636

3737
## Credits
3838

39-
This project is inspired and based on:
39+
This project is inspired by and based on:
4040

4141
- https://github.com/vitest-dev/vitest-ecosystem-ci
4242
- https://github.com/vitejs/vite-ecosystem-ci

0 commit comments

Comments
 (0)