Skip to content

Commit 0c318bb

Browse files
Merge pull request #22 from morgen-peschke/post-release-0.2.0-documentation-updates
Bump version number in README and add overview for commons-shims
2 parents 637dd80 + 2beffe2 commit 0c318bb

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,22 @@ Common utility libraries for Scala, mostly small stuff I don't want to have mult
77
### SBT
88
```
99
libraryDependencies += Seq(
10-
"com.github.morgen-peschke" % "commons-core" % "0.1.0",
11-
"com.github.morgen-peschke" % "commons-collections" % "0.1.0",
12-
"com.github.morgen-peschke" % "commons-decline" % "0.1.0",
13-
"com.github.morgen-peschke" % "commons-scalacheck" % "0.1.0" % Test
10+
"com.github.morgen-peschke" % "commons-core" % "0.2.0",
11+
"com.github.morgen-peschke" % "commons-collections" % "0.2.0",
12+
"com.github.morgen-peschke" % "commons-decline" % "0.2.0",
13+
"com.github.morgen-peschke" % "commons-shims" % "0.2.0",
14+
"com.github.morgen-peschke" % "commons-scalacheck" % "0.2.0" % Test
1415
)
1516
```
1617

1718
### Mill
1819
```
1920
def ivyDeps = Agg(
20-
ivy"com.github.morgen-peschke::commons-core:0.1.0",
21-
ivy"com.github.morgen-peschke::commons-collections:0.1.0",
22-
ivy"com.github.morgen-peschke::commons-decline:0.1.0",
23-
ivy"com.github.morgen-peschke::commons-scalacheck:0.1.0"
21+
ivy"com.github.morgen-peschke::commons-core:0.2.0",
22+
ivy"com.github.morgen-peschke::commons-collections:0.2.0",
23+
ivy"com.github.morgen-peschke::commons-decline:0.2.0",
24+
ivy"com.github.morgen-peschke::commons-shims:0.2.0",
25+
ivy"com.github.morgen-peschke::commons-scalacheck:0.2.0"
2426
)
2527
```
2628

@@ -73,3 +75,11 @@ Highlights include:
7375
### `commons-decline`
7476

7577
Instances for Decline, notably one for `Slice` as it tends to be very handy for CLI utilities.
78+
79+
### `commons-shims`
80+
81+
Everything in this module has a better alternative in another library. If, however, you're not able to access
82+
the better version, this module aims to provide at least some comfort in the form of minimal dependency alternatives.
83+
84+
The primary example is `Managed`, which solves the same general problem as Java's try-with-resource construct, and
85+
is far better solved by `cats.effect.Resource`.

0 commit comments

Comments
 (0)