Merge pull request #2 from romdo/add-coverage-and-readme-badges

chore: add coverage checks and readme badges

.github/workflows/ci.yml

@@ -63,31 +63,31 @@ jobs:
   #         github-token: ${{ secrets.GITHUB_TOKEN }}
   #         auto-push: false
 
-  # cov:
+  cov:
-  #   name: Coverage
+    name: Coverage
-  #   runs-on: ubuntu-latest
+    runs-on: ubuntu-latest
-  #   steps:
+    steps:
-  #     - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
-  #     - uses: actions/setup-go@v2
+      - uses: actions/setup-go@v2
-  #       with:
+        with:
-  #         go-version: 1.15
+          go-version: 1.15
-  #     - uses: actions/cache@v2
+      - uses: actions/cache@v2
-  #       with:
+        with:
-  #         path: ~/go/pkg/mod
+          path: ~/go/pkg/mod
-  #         key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-  #         restore-keys: |
+          restore-keys: |
-  #           ${{ runner.os }}-go-
+            ${{ runner.os }}-go-
-  #     - name: Publish coverage
+      - name: Publish coverage
-  #       uses: paambaati/codeclimate-action@v2.7.4
+        uses: paambaati/codeclimate-action@v2.7.4
-  #       env:
+        env:
-  #         VERBOSE: "true"
+          VERBOSE: "true"
-  #         GOMAXPROCS: 4
+          GOMAXPROCS: 4
-  #         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-  #       with:
+        with:
-  #         coverageCommand: make cov
+          coverageCommand: make cov
-  #         prefix: github.com/${{ github.repository }}
+          prefix: github.com/${{ github.repository }}
-  #         coverageLocations: |
+          coverageLocations: |
-  #           ${{ github.workspace }}/coverage.out:gocov
+            ${{ github.workspace }}/coverage.out:gocov
 
   test:
     name: Test

README.md

@@ -1,5 +1,5 @@
 <h1 align="center">
-  romdo/go-validate
+  go-validate
 </h1>
 
 <p align="center">
@@ -9,7 +9,31 @@
   </strong>
 </p>
 
----
+<p align="center">
+  <a href="https://pkg.go.dev/github.com/romdo/go-validate">
+    <img src="https://img.shields.io/badge/%E2%80%8B-reference-387b97.svg?logo=go&logoColor=white"
+  alt="Go Reference">
+  </a>
+  <a href="https://github.com/romdo/go-validate/releases">
+    <img src="https://img.shields.io/github/v/tag/romdo/go-validate?label=release" alt="GitHub tag (latest SemVer)">
+  </a>
+  <a href="https://github.com/romdo/go-validate/actions">
+    <img src="https://img.shields.io/github/workflow/status/romdo/go-validate/CI.svg?logo=github" alt="Actions Status">
+  </a>
+  <a href="https://codeclimate.com/github/romdo/go-validate">
+    <img src="https://img.shields.io/codeclimate/coverage/romdo/go-validate.svg?logo=code%20climate" alt="Coverage">
+  </a>
+  <a href="https://github.com/romdo/go-validate/issues">
+    <img src="https://img.shields.io/github/issues-raw/romdo/go-validate.svg?style=flat&logo=github&logoColor=white"
+alt="GitHub issues">
+  </a>
+  <a href="https://github.com/romdo/go-validate/pulls">
+    <img src="https://img.shields.io/github/issues-pr-raw/romdo/go-validate.svg?style=flat&logo=github&logoColor=white" alt="GitHub pull requests">
+  </a>
+  <a href="https://github.com/romdo/go-validate/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/romdo/go-validate.svg?style=flat" alt="License Status">
+  </a>
+</p>
 
 Add validation to any type, by simply implementing the `Validatable` interface: