Skip to content

Commit 3d6ed43

Browse files
committed
chore: update README
1 parent ff8bab8 commit 3d6ed43

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,8 @@
22

33
A monorepo which contains the following packages:
44

5-
- `@currents/jest` - a jest reporter that writes the test results to json files in a Currents friendly manner
6-
- `@currents/cmd` - exposes the `currents` command which is used to interact with Currents APIs. It includes the following commands:
7-
- `upload` command - used to discover the full test suite and upload the test results into the Currents Dashboard
8-
- `api` command - retrieves information about Currents entities
9-
- `cache` command - provides a convenient way to store and receive test artifacts
5+
- `@currents/jest` - Currents jest reporter ([documentation](https://docs.currents.dev/resources/reporters/currents-jest)).
6+
- `@currents/cmd` - `currents` CLI command ([documentation](https://docs.currents.dev/resources/reporters/currents-cmd))
107
- `examples` - a private package used to test the implementation
118

129
## Testing locally
@@ -73,7 +70,7 @@ git checkout -b release/cmd-1.1.0
7370

7471
Push that branch to the repo. (It has to be present on the remote for `release-it` to run).
7572

76-
Release the package by running the release task which tags, and pushes the release.
73+
Release the package by running the release task which tags, and pushes the release.
7774

7875
```sh
7976
cd ./packages/name

0 commit comments

Comments
 (0)