From 3fb2c16f84b91d7c537bc85078cfca5e727573b4 Mon Sep 17 00:00:00 2001 From: Andrew Weiss Date: Mon, 14 Jan 2019 16:36:16 -0500 Subject: [PATCH] update README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d18dd172..a4a169f9 100644 --- a/README.md +++ b/README.md @@ -206,6 +206,12 @@ Compile for Windows: $ GOOS=windows GOARCH=amd64 make +### Website and documentation + +Both the website and corresponding documentation are being developed in `docs/`. The content is developed using the [Hugo](https://gohugo.io/) framework. The static content is generated and published in `docs/public`, which is a separate Git worktree that is tied to the [`gh-pages`](/~https://github.com/docker/oscalkit/tree/gh-pages) branch and publically accessible via https://docker.github.io/oscalkit. + +The GoDoc for the SDK can be found [here](https://godoc.org/github.com/docker/oscalkit). + ### Releasing The [GoReleaser](https://goreleaser.com/) tool is used to publish `oscalkit` to GitHub Releases. The following release artifacts are currently supported: