feat!: significant rewrite, including new options, frame processing, …

…testing & documentation (#63)

.github/workflows/ci.yml

@@ -1,3 +1,4 @@
+#file: noinspection SpellCheckingInspection
 name: CI
 
 on:
@@ -23,6 +24,22 @@ jobs:
         run: cargo test
       - name: docs
         run: cargo doc --no-deps
+  coverage:
+    runs-on: ubuntu-latest
+    container:
+      image: xd009642/tarpaulin:develop-nightly
+      options: --security-opt seccomp=unconfined
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: generate coverage
+        run: |
+          cargo +nightly tarpaulin --verbose --all-features --workspace --timeout 120 --out xml
+      - name: upload coverage
+        uses: codecov/codecov-action@v2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
   enforce-clean-code:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -3,7 +3,8 @@
 # Ignore any sample files, except for .jpg that don't have _bordered in the name
 samples/*
 !samples/*.jpg
-samples/*_bordered.jpg
+!samples/*.png
+samples/*_bordered*
 
 # Generated by Cargo
 # will have compiled files and executables