chore: jest readme

currents-dev · Jul 10, 2024 · b9562ba · b9562ba
1 parent 1f0e6a6
commit b9562ba
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/packages/jest/README.md b/packages/jest/README.md
@@ -36,13 +36,13 @@ or set the `--reporters` option when running the Jest CLI
 npx jest --reporters=@currents/jest
 ```
 
-When the Jest command is executed in the terminal, a folder named using the pattern ".currents-report-[timestamp]-[uuidv4()]" will be created in your root directory. This folder will contain information about your tests and the configuration used to generate it.
+The reporter saves the test results in a folder named using the pattern `.currents-report-[timestamp]-[uuidv4()]` in the root directory. We recomment to add `.currents-report*` to your `.gitignore` file.
 
 ## Configuration
 
-| Property    | Type     | Description                                               | Environment variable  | Default                                 |
-| ----------- | -------- | --------------------------------------------------------- | --------------------- | --------------------------------------- |
-| `reportDir` | `STRING` | The path where the plugin will output the Currents report | `CURRENTS_REPORT_DIR` | ".currents-report-[timestamp]-[uuidv4]" |
+| Property    | Type     | Description            | Environment variable  | Default                                 |
+| ----------- | -------- | ---------------------- | --------------------- | --------------------------------------- |
+| `reportDir` | `string` | Test results directory | `CURRENTS_REPORT_DIR` | `.currents-report-[timestamp]-[uuidv4]` |
 
 ## Troubleshooting