Merge branch 'main' of github.com:GeorgyFirsov/kdf-lib

Author: GeorgiiFirsov

.github/workflows/publish-documentation.yml

@@ -0,0 +1,33 @@
+name: Publish documentation
+
+on:
+    release:
+        types: [published]
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Installing necessary tools
+              run: |
+                sudo apt-get install doxygen
+                sudo apt-get install graphviz
+            
+            - name: Checkout repository
+              uses: actions/checkout@v3
+              with:
+                fetch-depth: 0
+                submodules: 'recursive'
+            
+            - name: Configure Doxygen with CMake
+              run: cmake . -DKDFLIB_GENERATE_DOCS=ON -DKDFLIB_DOCS_ONLY=ON -DKDFLIB_GITHUB_DOCS=ON -DKDFLIB_PRETTY_DOCS=ON
+
+            - name: Generate documentation
+              run: doxygen docs/Doxyfile
+
+            - name: Publish generated content to GitHub Pages
+              uses: JamesIves/github-pages-deploy-action@v4
+              with:
+                folder: doxygen/html
+                token: ${{ secrets.ACCESS_TOKEN }}

README.md

@@ -1,2 +1,10 @@
 # kdf-lib
-Implementation of key derivation functions (KDF)
+
+> **Warning** 
+> This library is implemented for research purposes only! It *intentionally* doesn't verify some parameters 
+> for validity. In real world all parameters MUST be properly verified.
+
+[![Tests](https://github.com/GeorgyFirsov/kdf-lib/actions/workflows/run-tests.yml/badge.svg)](https://github.com/GeorgyFirsov/kdf-lib/actions/workflows/run-tests.yml)
+[![codecov](https://codecov.io/gh/GeorgyFirsov/kdf-lib/graph/badge.svg?token=etV8xP3nd0)](https://codecov.io/gh/GeorgyFirsov/kdf-lib)
+
+Implementation of key derivation functions (KDF).