doc: Update document. (#29)

jaywcjlove · Nov 25, 2023 · 54f5823 · 54f5823
1 parent ba8390c
commit 54f5823
Show file tree

Hide file tree

Showing 2 changed files with 28,290 additions and 1,591 deletions.
diff --git a/README.md b/README.md
@@ -53,7 +53,8 @@ You can add `![Coverage](./coverage/badges.svg)` to your README.md after the bad
 - `output` - Output image path.
 - `label` - The left label of the badge, usually static (default `coverage`).
 - `style` - Badges style: `flat`, `classic` (default `classic`).
-- `type` - Coverage report type: `lines`, `statements`, `functions`, `branches` (default `statements`)
+- ~~`type`~~ - (No longer supported after v1.2.0) Coverage report type: `lines`, `statements`, `functions`, `branches` (default `statements`)
+- `jsonPath` - Path to the coverage percentage number to be used in the badge
 - `icon` - Path to icon file
 
 ```yml