test codecov workflow

.github/workflows/coverage.yml

@@ -0,0 +1,24 @@
+name: coverage
+
+on: 
+  push:
+    branches: ["main"]
+jobs:
+  test:
+    name: coverage
+    runs-on: ubuntu-latest
+    container:
+      image: xd009642/tarpaulin:latest
+      options: --security-opt seccomp=unconfined
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Generate code coverage
+        run: |
+          cargo tarpaulin --verbose --all-features --exclude-files "examples/*.rs" "benches/*.rs" --timeout 120 --out xml
+
+      - name: Upload to codecov.io
+        uses: codecov/codecov-action@v2
+        with:
+          verbose: true

.gitignore

@@ -14,4 +14,6 @@ Cargo.lock
 *.pdb
 
 # project-based Visual Studio Code settings
-.vscode
+.vscode
+# codecode output
+cobertura.xml

Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 authors = ["Tom Krüger"]
-description = "Perplex numbers based on num-traits"
-documentation = "https://github.com/tomtuamnuq/perplex_num"
+description = "Perplex (hyperbolic or split-complex) numbers based on num-traits"
+documentation = "https://docs.rs/perplex_num"
 homepage = "https://github.com/tomtuamnuq/perplex_num"
-keywords = ["mathematics", "numerics", "hyperbolic"]
-categories = ["algorithms", "science"]
+keywords = ["perplex-numbers", "hyperbolic-geometry", "algebra", "split-complex", "mathematics", "numerics", "scientific-computing"]
+categories = ["algorithms", "science::mathematics", "simulation"]
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/tomtuamnuq/perplex_num"
 name = "perplex_num"

README.md

@@ -62,6 +62,14 @@ fn main() {
 }
 ```
 
+## Coverage
+
+Test coverage report is generated with [cargo tarpaulin](https://github.com/xd009642/tarpaulin) invoke it with:
+```sh
+cargo tarpaulin --verbose --all-targets --skip-clean --exclude-files "examples/*.rs" "benches/*.rs"
+```
+
+
 ## Compatibility
 The `perplex_num` crate is tested for rustc 1.76.