diff --git a/README.md b/README.md index 9ce3bcc..b4769f4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,64 @@ -# entangle +

+
+ kairos-white-column 5bc2fe34
+ Entangle +
+

+ +

Entangle kubernetes connections running on remote clusters, also behind NAT

+

+ + license + + + docs + + go report card +

+ + +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. + + + + + + + + + + + +
+ +

+ +Documentation + +

+
+ +

+ +Contribute + +

+
+ + 📚 [Getting started with Kairos](https://kairos.io/docs/getting-started)
:bulb: [Examples](https://kairos.io/docs/examples)
:movie_camera: [Video](https://kairos.io/docs/media/)
:open_hands:[Engage with the Community](https://kairos.io/community/) + +
+ +🙌[ CONTRIBUTING.md ]( https://github.com/kairos-io/kairos/blob/master/CONTRIBUTING.md )
:raising_hand: [ GOVERNANCE ]( https://github.com/kairos-io/kairos/blob/master/GOVERNANCE.md )
:construction_worker:[Code of conduct](https://github.com/kairos-io/kairos/blob/master/CODE_OF_CONDUCT.md) + +
| :exclamation: | This is experimental! | |-|:-| -This is the Kairos entangle Kubernetes Native Extension. +## Installation To install, use helm: @@ -29,6 +84,8 @@ TEST SUITE: None $ helm install kairos-entangle kairos/entangle ``` +Documentation is available at: https://kairos.io/docs/reference/entangle/ + ## License Copyright 2022.