From 9360513a5132ac5a7a64a6433120cabdce066c39 Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Mon, 12 Jun 2017 10:52:07 -0400 Subject: [PATCH] Add documentation list Adds an "index" with a list of all documentation on the README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6214f4c5..21c4fc1f 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,19 @@ To create a multi-platform binary, use the `cross` command via `make`: $ make cross ``` +## Documentation + +Documentation can be found at our [kompose.io](http://kompose.io) website or our [docs](https://github.com/kubernetes-incubator/kompose/tree/master/docs) folder. + +Here is a list of all available docs: + +- [Quick start](docs/quickstart.md) +- [Setup](docs/setup.md) +- [User guide](docs/user-guide.md) +- [Conversion](docs/conversion.md) +- [Architecture](docs/architecture.md) +- [Development](docs/development.md) + ## Contributing and Issues `kompose` is a work in progress, we will see how far it takes us. We welcome any pull request to make it even better.