Merge pull request #1 from cloudmitigator/dev-readme-update

Update README

README.md

@@ -1,24 +1,54 @@
 # reflex-aws-kms-key-rotation-disabled
-A Reflex Rule for enforcing KMS Key rotation
+A Reflex rule for enforcing KMS Key rotation.
+
+To learn more about KMS Key rotation, see [the AWS Documentation](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html).
+
+## Getting Started
+To get started using Reflex, check out [the Reflex Documentation](https://docs.cloudmitigator.com/).
 
 ## Usage
 To use this rule either add it to your `reflex.yaml` configuration file:  
 ```
 rules:
-  - reflex-aws-kms-key-rotation-disabled:
-      version: latest
+  aws:
+    - kms-key-rotation-disabled:
+        configuration:
+          mode: remediate
+        version: latest
 ```
 
 or add it directly to your Terraform:  
 ```
-...
-
-module "reflex-aws-kms-key-rotation-disabled" {
-  source           = "github.com/cloudmitigator/reflex-aws-kms-key-rotation-disabled"
+module "kms-key-rotation-disabled" {
+  source            = "git::https://github.com/cloudmitigator/reflex-aws-kms-key-rotation-disabled.git?ref=latest"
+  sns_topic_arn     = module.central-sns-topic.arn
+  reflex_kms_key_id = module.reflex-kms-key.key_id
+  mode              = "remediate"
 }
-
-...
 ```
 
+Note: The `sns_topic_arn` and `reflex_kms_key_id` example values shown here assume you generated resources with `reflex build`. If you are using the Terraform on its own you need to provide your own valid values.
+
+## Configuration
+This rule has the following configuration options:
+
+<dl>
+  <dt>mode</dt>
+  <dd>
+  <p>Sets the rule to operate in <code>detect</code> or <code>remediate</code> mode.</p>
+
+  <em>Required</em>: No  
+
+  <em>Type</em>: string
+
+  <em>Possible values</em>: `detect` | `remediate`  
+
+  <em>Default</em>: `detect`
+  </dd>
+</dl>
+
+## Contributing
+If you are interested in contributing, please review [our contribution guide](https://docs.cloudmitigator.com/about/contributing.html).
+
 ## License
 This Reflex rule is made available under the MPL 2.0 license. For more information view the [LICENSE](https://github.com/cloudmitigator/reflex-aws-kms-key-rotation-disabled/blob/master/LICENSE)