Skip to content
This repository has been archived by the owner on Feb 27, 2021. It is now read-only.

Commit

Permalink
Updated README for dotty goodness
Browse files Browse the repository at this point in the history
  • Loading branch information
djspiewak committed Aug 9, 2020
1 parent b8e83bb commit 205d3af
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Toss that at the top of any files which need to work with APIs written in terms
Add the following to your SBT configuration:

```sbt
libraryDependencies += "com.codecommit" %% "shims" % "<version>"
libraryDependencies += "com.codecommit" %%% "shims" % "<version>"
```

If you're using scala.js, use `%%%` instead. Cross-builds are available for Scala 2.11, 2.12, and 2.13. It is *strongly* recommended that you enable the relevant SI-2712 fix in your build if using 2.11 or 2.12. [Details here](https://github.com/typelevel/cats/tree/b23c7fbc117856910fa43de205457d8637eef8c6#getting-started). A large number of conversions will simply *not work* without partial unification.
Cross-builds are available for Scala 2.12 and 2.13, and Dotty 0.25.0 and 0.26.0-RC1. ScalaJS builds target the 1.x line. It is *strongly* recommended that you enable the relevant SI-2712 fix in your build if using 2.12. [Details here](https://github.com/typelevel/cats/tree/b23c7fbc117856910fa43de205457d8637eef8c6#getting-started). A large number of conversions will simply *not work* without partial unification.

Note that shims generally follows `epoch.major.minor` versioning schemes, meaning that changes in the second component may be breaking. This is mostly because maintaining strict semver with shims would be *immensely* difficult due to the way the conversions interact. Shims is more of a leaf-level project, anyway, so semantic versioning is somewhat less critical here. Feel free to open an issue and make your case if you disagree, though.

Expand Down

0 comments on commit 205d3af

Please sign in to comment.