Skip to content

Commit 50b2484

Browse files
committed
Update readme to be slightly more informative
1 parent 54fe725 commit 50b2484

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,29 @@
44

55
The Sentry Prevent CLI is responsible for uploading code coverage and test results to Sentry. It can be used directly or indirectly through our [Sentry Prevent GitHub Action](https://github.com/getsentry/prevent-action).
66

7-
This Repo and README are still a work in progress.
7+
## What happened to the Codecov CLI?
8+
9+
The Codecov CLI is still around! We have moved the Codecov CLI's codebase into the `codecov-cli` sub-project in this repository because the Sentry Prevent CLI uses it as a backend and we wanted to keep the projects together in the `getsentry` organization. The Codecov CLI is still being maintained, improved, and published - just from this repository. See the sub-project's [README](/codecov-cli/README.md) for Codecov CLI specific information, the rest of this document will be about the Prevent CLI.
10+
11+
- [Installing](#installing)
12+
- [Usage](#usage)
13+
- [Contributions](#contributions)
14+
- [Releases](#releases)
15+
16+
# Installing
17+
18+
As of today, you are not able to install the Sentry Prevent CLI. We are planning to release it on the PyPI and for direct download in the near future.
19+
20+
If you're determined, you can build the CLI yourself from source by running `uv build` in the `prevent-cli` directory.
21+
22+
# Usage
23+
24+
If the installation is successful, running `sentry-prevent-cli --help` will output the available commands along with the different options that can be used with them.
25+
26+
# Contributions
27+
28+
Todo
29+
30+
# Releases
31+
32+
Todo

0 commit comments

Comments
 (0)