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 <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2018-05-18 11:21:35 +01:00
parent be82c7fc6f
commit ce5dda8249

View File

@ -18,7 +18,10 @@ For details of the other Kata Containers repositories, see the
* [Configuration](#configuration) * [Configuration](#configuration)
* [Logging](#logging) * [Logging](#logging)
* [Debugging](#debugging) * [Debugging](#debugging)
* [Limitations](#limitations)
* [Community](#community) * [Community](#community)
* [Contact](#contact)
* [Further information](#further-information)
## Introduction ## Introduction
@ -143,6 +146,23 @@ tool.
See the See the
[debugging section of the developer guide](https://github.com/kata-containers/documentation/blob/master/Developer-Guide.md#enable-full-debug). [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 ## Community
See [the community repository](https://github.com/kata-containers/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).