From ce5dda8249c2f16913d0a069a1f9cd276eaa9b44 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Fri, 18 May 2018 11:21:35 +0100 Subject: [PATCH] docs: Add more details to the README Add brief entries to the README for the following: - Limitations - Contact details - Further information Fixes #322. Signed-off-by: James O. D. Hunt --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index cdfa9fea6e..d41b0692f2 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,10 @@ For details of the other Kata Containers repositories, see the * [Configuration](#configuration) * [Logging](#logging) * [Debugging](#debugging) +* [Limitations](#limitations) * [Community](#community) + * [Contact](#contact) +* [Further information](#further-information) ## Introduction @@ -143,6 +146,23 @@ tool. See the [debugging section of the developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md#enable-full-debug). +## Limitations + +See the +[limitations file](https://github.com/kata-containers/documentation/blob/master/Limitations.md) +for further details. + ## Community See [the community repository](https://github.com/kata-containers/community). + +### Contact + +See [how to reach the community](https://github.com/kata-containers/community/blob/master/CONTRIBUTING.md#contact). + +## Further information + +See the +[project table of contents](https://github.com/kata-containers/kata-containers) +and the +[documentation repository](https://github.com/kata-containers/documentation).