From afe4202448ec145c7472fefcfe14336be47b3a87 Mon Sep 17 00:00:00 2001 From: ashpect Date: Mon, 2 Sep 2024 04:35:21 +0530 Subject: [PATCH] update docs in ReadMe --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 98fafaa5..1caf1173 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # katana -An advanced yet simple attack/defence CTF infrastructure in Go +An advanced yet simple attack/defence CTF infrastructure in Go build upon k8s. ## Setup - To start, you must have the following installed: @@ -7,3 +7,9 @@ An advanced yet simple attack/defence CTF infrastructure in Go - Minikube & kubectl - Run `make set-env` to setup the environment - To start katana, run `./bin/katana run` + +## Docs +- To get the most stable docs : + - Setup docs locally by running `make setup-docs` followed by `hugo serve` from the `docs` directory. + - The docs are also available at [https://blog.sdslabs.co/katana](https://blog.sdslabs.co/katana/Katana/getting-started/). +- To visit the most updated docs, it's advised to setup the docs locally from the docs branch. \ No newline at end of file