Skip to content

Commit d3c2568

Browse files
committed
update readme
1 parent bc17a87 commit d3c2568

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,26 @@ Repository of custom scalafix rules for Iterable projects.
44

55
## Usage
66

7-
See the tags on this repo to find the the latest version or the version you want to use. You can use the rules in your project by adding a dependency to the `scalafix-rules` artifact:
7+
You can use the rules in your project by adding a dependency on your preferred version of [the `scalafix-rules` artifact](https://mvnrepository.com/artifact/com.iterable/scalafix-rules):
88

99
```scala
1010
ThisBuild / libraryDependencies += "com.iterable" %% "scalafix-rules" % "0.1.0" % ScalafixConfig
1111
```
1212

1313
This will make the rules available to reference in your `.scalafix.conf` file.
1414

15-
You can also run directly from the sbt console without including it in your build.
15+
You can also run a rule directly from the sbt console without including it in your build.
1616
For example, to run version `0.1.0` of `NoFutureTraverse` dynamically in the `sbt` console:
1717

1818
```
1919
scalafix dependency:[email protected]::scalafix-rules:0.1.0
2020
```
2121

22+
## Available Rules
23+
2224
### NoFutureTraverse
2325

24-
Disallows the use of `Future.traverse` in your Scala code, to prevent a potentially unbounded number of concurrent tasks from being run at once.
26+
Warns against or disallows the use of `Future.traverse` in your Scala code, to prevent a potentially unbounded number of concurrent tasks from being run at once.
2527

2628
```hocon
2729
rules = [
@@ -30,6 +32,6 @@ rules = [
3032
]
3133
3234
NoFutureTraverse {
33-
isError = true # Whether to treat violations as errors (default: true)
35+
isError = true # Whether to treat violations as errors (default: false)
3436
}
3537
```

0 commit comments

Comments
 (0)