docs

Author: AleksaC

README.md

@@ -0,0 +1,46 @@
+# TFLint Misc Ruleset
+
+Tflint ruleset containing miscellaneous rules that don't fit into other rulesets.
+
+## Installation
+
+You can install the plugin with `tflint --init`. Declare a config in `.tflint.hcl` as follows:
+
+```hcl
+plugin "misc" {
+  enabled = true
+  version = "0.1.0"
+  source  = "github.com/AleksaC/tflint-ruleset-misc"
+}
+```
+
+## Rules
+
+|Name|Description|Severity|Enabled|Link|
+| --- | --- | --- | --- | --- |
+|no_multiline_comments|Disallows usage of multiline comments|WARNING|✔|https://github.com/AleksaC/tflint-ruleset-misc/tree/main/docs/rules/no_multiline_comments.md|
+
+## Building the plugin
+
+Clone the repository locally and run the following command:
+
+```
+$ make
+```
+
+You can easily install the built plugin with the following:
+
+```
+$ make install
+```
+
+You can run the built plugin like the following:
+
+```console
+$ cat << EOS > .tflint.hcl
+plugin "misc" {
+  enabled = true
+}
+EOS
+$ tflint
+```

docs/rules/no_multiline_comments.md

@@ -0,0 +1 @@
+# No Multiline Comments