Skip to content

Commit 8e294ab

Browse files
authored
docs: Update readme to be slightly more informative (#76)
Updates readme
1 parent 54fe725 commit 8e294ab

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,28 @@
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+
> [!NOTE]
8+
> 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.
9+
10+
- [Installing](#installing)
11+
- [Usage](#usage)
12+
- [Contributions](#contributions)
13+
- [Releases](#releases)
14+
15+
# Installing
16+
17+
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.
18+
19+
If you're determined, you can build the CLI yourself from source by running `uv build` in the `prevent-cli` directory.
20+
21+
# Usage
22+
23+
Todo
24+
25+
# Contributions
26+
27+
Todo
28+
29+
# Releases
30+
31+
Todo

0 commit comments

Comments
 (0)