Merge pull request #37 from YiannisGkoufas/master

Readme update

Author: k8s-ci-robot

Diff for: README.md

@@ -1,6 +1,46 @@
 # Container Object Storage Controller
 
 Container Object Storage Interface (COSI) controller responsible to manage lifecycle of COSI objects.
+Specifically, this controller monitors the lifecycle of the user-facing CRDs:
+
+- BucketRequest - Represents a request to provision a Bucket
+- BucketAccessRequest - Represents a request to access a Bucket
+
+and generates the associated CRDs:
+
+- Bucket - Represents a Bucket or its equivalent in the storage backend
+- BucketAccess - Represents a access token or service account in the storage backend
+
+## Developer Guide
+
+Before diving into the code of this repo, we suggest that you familiarize yourself with:
+
+- The Spec of CRDs in [objectstorage.k8s.io/v1alpha1/types.go](https://github.com/kubernetes-sigs/container-object-storage-interface-api/blob/master/apis/objectstorage.k8s.io/v1alpha1/types.go)
+- The Spec of the COSI objects [sigs.k8s.io/container-object-storage-interface-spec](https://github.com/kubernetes-sigs/container-object-storage-interface-spec)
+
+A good starting point towards understanding the functionality of this repo would be to study the tests:
+
+- [BucketRequest Test](./pkg/bucketrequest/bucketrequest_test.go)
+- [BucketAccessRequest Test](./pkg/bucketaccessrequest/bucketaccessrequest_test.go)
+
+### Build and Test
+
+In order to build and generate a Docker image execute:
+```bash
+make container
+```
+
+In order to run the tests execute:
+```bash
+make test
+```
+
+## References
+
+- [Documentation](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/index.md)
+- [Deployment Guide](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/deployment-guide.md)
+- [Weekly Meetings](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/meetings.md)
+- [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/8)
 
 ## Community, discussion, contribution, and support