Skip to content

Commit 2042f90

Browse files
Clarify README (#907)
1 parent bc9cf65 commit 2042f90

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
TFLint ruleset plugin for Terraform AWS Provider
77

8-
This ruleset focus on possible errors and best practices about AWS resources. Many rules are enabled by default and warn against code that might fail when running `terraform apply`, or clearly unrecommened.
8+
This ruleset focus on possible errors and best practices about AWS resources. In other words, the rules warn against code that might fail when running `terraform apply` or practices that should be avoided.
99

1010
## Requirements
1111

@@ -14,7 +14,7 @@ This ruleset focus on possible errors and best practices about AWS resources. Ma
1414

1515
## Installation
1616

17-
You can install the plugin by adding a config to `.tflint.hcl` and running `tflint --init`:
17+
After configuring [TFLint](https://github.com/terraform-linters/tflint/blob/master/docs/user-guide/config.md), you can install the plugin by adding a config to `.tflint.hcl` and running `tflint --init`:
1818

1919
```hcl
2020
plugin "aws" {
@@ -24,7 +24,7 @@ plugin "aws" {
2424
}
2525
```
2626

27-
For more configuration about the plugin, see [Plugin Configuration](docs/configuration.md).
27+
For more information about configuration options for this ruleset plugin, see [Plugin Configuration](docs/configuration.md).
2828

2929
## Getting Started
3030

0 commit comments

Comments
 (0)