aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index f4f0b3e..b87138d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
# ao-coverage
-A simple coverage handler and server. \ No newline at end of file
+A simple coverage handler and server. The basic function provides an SVG badge with the coverage percentage and a link to the uploaded HTML coverage report. Only basic metadata is required to persist to track the latest commits for the linked branches.
+
+Currently, the only supported code coverage format is [Tarpaulin](https://crates.io/crates/cargo-tarpaulin), which is specific to Rust. Recommended formats and pull requests are welcome! If you want an account for this Gitea to interact with this repository, please contact the maintainer at [kjhoerr@submelon.tech](mailto:kjhoerr@submelon.tech).