From 13de8e238778a798f24c847bdb4f0c81d1c6b209 Mon Sep 17 00:00:00 2001 From: Joel Thorstensson Date: Sat, 2 Sep 2023 10:11:47 +0200 Subject: [PATCH] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ab38cc6..30c067b1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,10 @@ Keramik is a Kubernetes operator for simulating Ceramic networks. The `k8s` directory contains the kubernetes manifests for deploying Keramik. -## Local Documentation +## Usage guide +[Have a look in the documentation](https://3box.github.io/keramik/). + +### Build Documentation Locally Documentation is done using [mdbook](https://rust-lang.github.io/mdBook/guide/installation.html) cargo install mdbook