From 1dab0d98c3f872b850068e1ff7fc66f50e4c149a Mon Sep 17 00:00:00 2001 From: Pulkit Kathuria Date: Mon, 25 Nov 2024 23:50:52 +0900 Subject: [PATCH] docs: move samples --- README.md | 26 +- README_BACK.md | 2 +- samples/2.svg | 5 + samples/3.svg | 1 + samples/4.svg | 1 + samples/5.svg | 1953 ++++++++++++++++++++++++++++++++++++++++++++++++ samples/6.svg | 613 +++++++++++++++ 7 files changed, 2592 insertions(+), 9 deletions(-) create mode 100644 samples/2.svg create mode 100644 samples/3.svg create mode 100644 samples/4.svg create mode 100644 samples/5.svg create mode 100644 samples/6.svg diff --git a/README.md b/README.md index cd63375..e24608d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@

- - coveritup app url - + coveritup app url

The Hassle-Free Code Coverage and Metrics Tracking Tool
A CodeCov and SonarQube alternative.
-
-

+

+ coveritup app url +

- Action and Self Hosted app for uploading Code Metrics + Action and Self Hosted app for uploading Code Metrics.

@@ -36,6 +35,10 @@

Add Progress To your README +
+
+        +

--- @@ -44,12 +47,19 @@ Add Badges To your README

+![npm-install-time](https://raw.githubusercontent.com/kevincobain2000/action-coveritup/refs/heads/master/samples/3.svg) + +![coverage](https://raw.githubusercontent.com/kevincobain2000/action-coveritup/refs/heads/master/samples/4.svg) + ---

Add Widgets To your README

+![npm-install-time](https://raw.githubusercontent.com/kevincobain2000/action-coveritup/refs/heads/master/samples/5.svg) +![go-test-run-time](https://raw.githubusercontent.com/kevincobain2000/action-coveritup/refs/heads/master/samples/6.svg) + --- **Quick Setup:** Quickly set up code coverage or other useful metrics on your project. @@ -184,7 +194,7 @@ Before using this action, enable Github Actions # Step 3) Embedding badges and charts Navigate to your repo and obtain embeding code for badges and charts. -https://coveritup.app/readme?org=kevincobain2000&repo=action-coveritup&branch=master +`/readme?org=kevincobain2000&repo=action-coveritup&branch=master` --- @@ -212,7 +222,7 @@ https://coveritup.app/readme?org=kevincobain2000&repo=action-coveritup&branch=ma `github.token` from your action is sent to the server as an Authorization header. The expiration of `github.token` is until the workflow is running. The token is used to verify if the request has originated from the correct org, repo and commit author. -https://coveritup.app doesn't store the token. +It doesn't store the token. You can see usage in `action.yml` file diff --git a/README_BACK.md b/README_BACK.md index a7252e0..efed6a3 100644 --- a/README_BACK.md +++ b/README_BACK.md @@ -47,7 +47,7 @@ Add Progress To your README

-        +       

diff --git a/samples/2.svg b/samples/2.svg new file mode 100644 index 0000000..8db6213 --- /dev/null +++ b/samples/2.svg @@ -0,0 +1,5 @@ + + + 47% + coverage + \ No newline at end of file diff --git a/samples/3.svg b/samples/3.svg new file mode 100644 index 0000000..c981d3f --- /dev/null +++ b/samples/3.svg @@ -0,0 +1 @@ +npm-install-time | masternpm-install-time | master7sec7sec \ No newline at end of file diff --git a/samples/4.svg b/samples/4.svg new file mode 100644 index 0000000..b064197 --- /dev/null +++ b/samples/4.svg @@ -0,0 +1 @@ +coverage | mastercoverage | master47.3%47.3% \ No newline at end of file diff --git a/samples/5.svg b/samples/5.svg new file mode 100644 index 0000000..3063703 --- /dev/null +++ b/samples/5.svg @@ -0,0 +1,1953 @@ +\nnpm-install-timemaster----2024/02/112024/05/2881 \ No newline at end of file diff --git a/samples/6.svg b/samples/6.svg new file mode 100644 index 0000000..a7e8add --- /dev/null +++ b/samples/6.svg @@ -0,0 +1,613 @@ +\ngo-test-run-timemaster----2024/02/092024/05/243533 \ No newline at end of file