Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: add docs link #354

Merged
merged 2 commits into from
Apr 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,14 @@ Contrast integrates fluently with the existing Kubernetes workflows. It's compat
* Minimal DevOps involvement.
* Simple CLI tool to get started.

## Documentation

To learn more, see the [documentation](https://docs.edgeless.systems/contrast).
You may want to start with one of the following sections.

* [Getting started](https://docs.edgeless.systems/contrast/getting-started)
* [Security benefits](https://docs.edgeless.systems/contrast/basics/security-benefits)
* [Components](https://docs.edgeless.systems/contrast/components)

## Current limitations

Expand All @@ -73,7 +80,6 @@ As a result, there are currently certain limitations from which we try to docume

## Upcoming Contrast features

- Transparent service mesh (apps can currently use mTLS with Coordinator certs for secure communication)
- Plugin for a key management service (KMS) for attestation/coordinator certificate-based key release
- High availability (distributed Contrast Coordinator)

Expand Down
Loading