Merge pull request #6 from terraform-linters/revise_docs

Revise documentation

Author: wata727

README.md

@@ -1,24 +1,11 @@
-# WORKING IN PROGRESS AND MAINTAINER WANTED!
-
-This project was started to support terraform-provider-google resources in TFLint. Everything is working in progress and not available as a plugin. If you are interested in this project, consider the following:
-
-- Open an issue for the rule you want
-  - Provider-specific knowledge is very important. Sharing the problems you faced will make it clear what we need to develop.
-- Write a rule and open a pull request
-  - If you are already familiar with tflint rulesets, Writing rules to solve open issues helps all users of TFLint. If you are interested but are not familiar, please let us know. Support you as much as possible.
-- Make automatic rule generation system
-  - In reality, it is impossible to manage rules for so many resources by hand. tflint has a mechanism to automatically generate AWS validation rules from aws-sdk (See [here](https://github.com/terraform-linters/tflint/blob/master/docs/DEVELOPING.md#sdk-based)). Building such a system can bring a lot of value at low cost.
-
-See [terraform-lintes/tflint#606](https://github.com/terraform-linters/tflint/issues/606) for more details.
-
 # TFLint Ruleset for terraform-provider-google
 
 TFLint ruleset plugin for Terraform Google Cloud Platform provider
 
 ## Requirements
 
-- TFLint v0.14+
-- Go v1.13
+- TFLint v0.20+
+- Go v1.15
 
 ## Installation
 
@@ -32,9 +19,7 @@ plugin "google" {
 
 ## Rules
 
-|Name|Description|Severity|Enabled|Link|
-| --- | --- | --- | --- | --- |
-|google_compute_instance_example_type|Show machine type|ERROR|✔||
+100+ rules are available. See the [documentation](docs/README.md).
 
 ## Building the plugin
 

docs/README.md

@@ -0,0 +1,13 @@
+# Rules
+
+This documentation describes a list of rules available by enabling this ruleset.
+
+## Basic Rules
+
+No rules
+
+## Magic Modules Rules
+
+These are the rules that warn against invalid values generated from [Magic Modules](https://github.com/terraform-linters/magic-modules). These rules are defined under the [`rules/magicmodules`](../rules/magicmodules) directory.
+
+See the [`tools`](../tools) directory for how to generate these rules.

go.mod

@@ -1,6 +1,6 @@
 module github.com/terraform-linters/tflint-ruleset-google
 
-go 1.13
+go 1.15
 
 require (
 	github.com/hashicorp/hcl/v2 v2.6.0