Update readme to point to development and contributing guide.

Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
Humble Chirammal
2019-04-04 12:13:48 +05:30
parent 92f663cf24
commit f0ea320104
3 changed files with 68 additions and 46 deletions

View File

@ -1,7 +1,7 @@
# Ceph CSI 1.0.0
[Container Storage Interface
(CSI)](https://github.com/container-storage-interface/) driver, provisioner,
This repo containes [Container Storage Interface(CSI)]
(<https://github.com/container-storage-interface/>) driver, provisioner,
and attacher for Ceph RBD and CephFS.
## Overview
@ -20,6 +20,13 @@ CephFS CSI plugins, see documentation in `docs/`.
For example usage of RBD and CephFS CSI plugins, see examples in `examples/`.
## Contributing to this repo
Please follow [development-guide]
(<https://github.com/ceph/ceph-csi/tree/master/docs/development-guide.md>) and
[coding style guidelines](<https://github.com/ceph/ceph-csi/tree/master/docs/coding.md>)
if you are interested to contribute to this repo.
## Troubleshooting
Please submit an issue at: [Issues](https://github.com/ceph/ceph-csi/issues)