Skip to content

Commit

Permalink
docs: update docs for after v1 release (#502)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdjastrzebski committed Jun 16, 2024
1 parent b18d581 commit 5f9127a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
- [Analyzing results](#analyzing-results)
- [API](#api)
- [Measurements](#measurements)
- [`measurePerformance` function](#measureperformance-function)
- [`MeasureOptions` type](#measureoptions-type)
- [`measureRenders` function](#measurerenders-function)
- [`MeasureRendersOptions` type](#measurerendersoptions-type)
- [`measureFunction` function](#measurefunction-function)
- [`MeasureFunctionOptions` type](#measurefunctionoptions-type)
- [Configuration](#configuration)
Expand Down
8 changes: 3 additions & 5 deletions docusaurus/docs/migration-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,15 @@ import TabItem from '@theme/TabItem';

## Installation

Reassure v1 RC is available using `next` npm tag:

<Tabs>
<TabItem value="npm" label="npm">
```sh
npm install --save-dev reassure@next
npm install --save-dev reassure
```
</TabItem>
<TabItem value="yarn" label="yarn">
```sh
yarn add --dev reassure@next
yarn add --dev reassure
```
</TabItem>
</Tabs>
Expand All @@ -37,7 +35,7 @@ The signature of the function did not change. Old name is no longer available.

## Testing environment

Reassure V0 used Node.js JIT-less mode (`--jitless` node flag), optionally using different flags if `--enable-wasp` experimental option was passed. Reassure V1 runs tests using Node.js's non-optimized compilation to better reflect React Native runtime environment.
Reassure v0 used Node.js JIT-less mode (`--jitless` node flag), optionally using different flags if `--enable-wasp` experimental option was passed. Reassure V1 runs tests using Node.js's non-optimized compilation to better reflect React Native runtime environment.

This means that:

Expand Down
11 changes: 2 additions & 9 deletions packages/reassure/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
- [Analyzing results](#analyzing-results)
- [API](#api)
- [Measurements](#measurements)
- [`measurePerformance` function](#measureperformance-function)
- [`MeasureOptions` type](#measureoptions-type)
- [`measureRenders` function](#measurerenders-function)
- [`MeasureRendersOptions` type](#measurerendersoptions-type)
- [`measureFunction` function](#measurefunction-function)
- [`MeasureFunctionOptions` type](#measurefunctionoptions-type)
- [Configuration](#configuration)
Expand Down Expand Up @@ -162,13 +162,6 @@ test('Test with scenario', async () => {

If your test contains any async changes, you will need to make sure that the scenario waits for these changes to settle, e.g. using `findBy` queries, `waitFor` or `waitForElementToBeRemoved` functions from RNTL.

For more examples, look into our example apps:

- [React Native (CLI)](https://github.com/callstack/reassure-examples/tree/main/examples/native-cli)
- [React Native (Expo)](https://github.com/callstack/reassure-examples/tree/main/examples/native-expo)
- [React (Next.js)](https://github.com/callstack/reassure-examples/tree/main/examples/web-nextjs)
- [React (Vite)](https://github.com/callstack/reassure-examples/tree/main/examples/native-expo)

### Measuring test performance

To measure your first test performance, you need to run the following command in the terminal:
Expand Down

0 comments on commit 5f9127a

Please sign in to comment.