Skip to content

Commit 5c035d0

Browse files
committed
Update README.md
1 parent f72df19 commit 5c035d0

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

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

33
<p align="center">
44
<a href="https://usetusk.ai">
5-
<img src="./static/images/tusk.png" width="200" title="Tusk">
5+
<img src="./static/images/tusk.png" width="200" title="Tusk" alt="Tusk">
66
</a>
77
</p>
88

@@ -15,16 +15,16 @@
1515

1616
</div>
1717

18-
Tusk is an AI testing platform that helps you catch blind spots, surface edge cases cases, and write verified tests for your commits.
18+
> [!NOTE]
19+
> For most users, we recommend following our [guide to set up your sandboxed test execution environment](https://docs.usetusk.ai/automated-tests/test-execution-environments).
20+
> If you have any questions, contact us at <support@usetusk.ai>.
1921
20-
This GitHub Action facilitates running Tusk-generated tests on Github runners.
22+
Tusk is an AI testing platform that helps you catch blind spots, surface edge cases cases, and write verified tests for your commits. This GitHub Action facilitates running Tusk-generated tests on Github runners.
2123

22-
## Usage
23-
24-
Onboard to the Tusk platform:
24+
New to Tusk? Check out our [main page](https://www.usetusk.ai/)
25+
or [docs](https://docs.usetusk.ai/automated-tests/overview).
2526

26-
- Set your team up on Tusk [[docs](https://docs.usetusk.ai/automated-tests/onboarding)].
27-
- Configure and validate your test execution environment (including a workflow that uses this action) through the setup wizard [[docs](https://docs.usetusk.ai/automated-tests/self-serve)].
27+
## Usage
2828

2929
When you push new commits, Tusk runs against your commit changes and generates tests. To ensure that test scenarios are meaningful and verified, Tusk will start this workflow and provision a runner (with a unique `runId`), using it as an ephemeral sandbox to run tests against your specific setup and dependencies. Essentially, this action polls for live commands emitted by Tusk based on the progress of the run, executes them, and sends the results back to Tusk for further processing.
3030

@@ -170,7 +170,7 @@ For calculating test coverage gains, we support Pytest and Jest at the moment.
170170

171171
Example:
172172

173-
```
173+
```text
174174
npm run test {{testFilePaths}} -- --coverage --coverageReporters=json-summary --coverageDirectory=./coverage
175175
```
176176

@@ -259,4 +259,4 @@ You will also need to set the number of sandboxes to use in the Tusk app. Tusk w
259259

260260
## Contact
261261

262-
Need help? Drop us an email at support@usetusk.ai.
262+
Need help? Drop us an email at <support@usetusk.ai>.

0 commit comments

Comments
 (0)