Merge pull request #36 from muvaf/readmenow

add readme

README.md

@@ -1,16 +1,28 @@
-# provider-tf-aws
+# Terrajet AWS Provider
 
-`provider-tf-aws` is a minimal [Crossplane](https://crossplane.io/) Provider
-that is meant to be used as a template for implementing new Providers. It comes
-with the following features that are meant to be refactored:
+`provider-tf-aws` is a [Crossplane](https://crossplane.io/) provider that is
+built using [Terrajet](https://github.com/crossplane-contrib/terrajet) code
+generation tools and exposes XRM-conformant managed resources for
+[Amazon AWS](https://aws.amazon.com/).
 
-- A `ProviderConfig` type that only points to a credentials `Secret`.
-- A `MyType` resource type that serves as an example managed resource.
-- A managed resource controller that reconciles `MyType` objects and simply
-  prints their configuration in its `Observe` method.
+## Getting Started
+
+Install the provider by using the following command after changing the image tag
+to the [latest release](https://github.com/crossplane-contrib/provider-tf-aws/releases):
+```
+kubectl crossplane install provider crossplane/provider-tf-aws:v0.2.0-alpha.1
+```
+
+You can see the API reference [here](https://doc.crds.dev/github.com/crossplane-contrib/provider-tf-aws).
 
 ## Developing
 
+Run code-generation pipeline:
+```console
+make prepare.azurerm
+go run cmd/generator/main.go
+```
+
 Run against a Kubernetes cluster:
 
 ```console
@@ -40,3 +52,35 @@ Build binary:
 ```console
 make build
 ```
+
+## Report a Bug
+
+For filing bugs, suggesting improvements, or requesting new features, please
+open an [issue](https://github.com/crossplane/provider-tf-aws/issues).
+
+## Contact
+
+Please use the following to reach members of the community:
+
+* Slack: Join our [slack channel](https://slack.crossplane.io)
+* Forums:
+  [crossplane-dev](https://groups.google.com/forum/#!forum/crossplane-dev)
+* Twitter: [@crossplane_io](https://twitter.com/crossplane_io)
+* Email: [[email protected]](mailto:[email protected])
+
+## Governance and Owners
+
+provider-tf-aws is run according to the same
+[Governance](https://github.com/crossplane/crossplane/blob/master/GOVERNANCE.md)
+and [Ownership](https://github.com/crossplane/crossplane/blob/master/OWNERS.md)
+structure as the core Crossplane project.
+
+## Code of Conduct
+
+provider-tf-aws adheres to the same [Code of
+Conduct](https://github.com/crossplane/crossplane/blob/master/CODE_OF_CONDUCT.md)
+as the core Crossplane project.
+
+## Licensing
+
+provider-tf-aws is under the Apache 2.0 license.