diff --git a/README.md b/README.md new file mode 100644 index 0000000..b5aee80 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +<h1 align="center"> + <br> + <img width="184" alt="kairos-white-column 5bc2fe34" src="https://user-images.githubusercontent.com/2420543/193010398-72d4ba6e-7efe-4c2e-b7ba-d3a826a55b7d.png"><br> + Kcrypt +<br> +</h1> + +<h3 align="center">Cloud native guardian for persistent data in the edge</h3> +<p align="center"> + <a href="https://opensource.org/licenses/"> + <img src="https://img.shields.io/badge/licence-APL2-brightgreen" + alt="license"> + </a> + <a href="https://github.com/kairos-io/kcrypt/issues"><img src="https://img.shields.io/github/issues/kairos-io/kcrypt"></a> + <a href="https://kairos.io/docs/" target=_blank> <img src="https://img.shields.io/badge/Documentation-blue" + alt="docs"></a> + <img src="https://img.shields.io/badge/made%20with-Go-blue"> + <img src="https://goreportcard.com/badge/github.com/kairos-io/kcrypt" alt="go report card" /> +</p> + + +With Kairos you can build immutable, bootable Kubernetes and OS images for your edge devices as easily as writing a Dockerfile. Optional P2P mesh with distributed ledger automates node bootstrapping and coordination. Updating nodes is as easy as CI/CD: push a new image to your container registry and let secure, risk-free A/B atomic upgrades do the rest. + + +<table> +<tr> +<th align="center"> +<img width="640" height="1px"> +<p> +<small> +Documentation +</small> +</p> +</th> +<th align="center"> +<img width="640" height="1"> +<p> +<small> +Contribute +</small> +</p> +</th> +</tr> +<tr> +<td> + + 📚 [Getting started with Kairos](https://kairos.io/docs/getting-started) <br> :bulb: [Examples](https://kairos.io/docs/examples) <br> :movie_camera: [Video](https://kairos.io/docs/media/) <br> :open_hands:[Engage with the Community](https://kairos.io/community/) + +</td> +<td> + +🙌[ CONTRIBUTING.md ]( https://github.com/kairos-io/kairos/blob/master/CONTRIBUTING.md ) <br> :raising_hand: [ GOVERNANCE ]( https://github.com/kairos-io/kairos/blob/master/GOVERNANCE.md ) <br>:construction_worker:[Code of conduct](https://github.com/kairos-io/kairos/blob/master/CODE_OF_CONDUCT.md) + +</td> +</tr> +</table> + +## Description + +This is the Kairos internal component which delegates encryption and decryption of partitions in a Kairos system. + +## Usage + +See the documentation in our website: https://kairos.io/docs/advanced/partition_encryption/.