deep-stack/kompose
7
0
Fork 0
forked from LaconicNetwork/kompose
Code Pull Requests Activity

Add documentation list

Browse Source 
Adds an "index" with a list of all documentation on the README.md
This commit is contained in:
Charlie Drage 2017-06-12 10:52:07 -04:00
parent dbf15e2e71
commit 9360513a51
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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.