Skip to content

Commit

Permalink
* add version support matrix into readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GreyPlane committed Sep 19, 2023
1 parent 1b56fef commit dfa11de
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ This project provides tools for working with JSON values using [circe][circe] an
it was promoted to its own project in order to decouple its releases (and the Scala versions it
is cross-published for) from the main circe modules.

## Versioning

This library releases at a different cadence than [Circe] and [Monocle], any apparent relationship between the [Circe] or [Monocle] version numbers
and circe-optics version numbers are a coincidence and NOT intentional. Please use the following table for determining
capability with the corresponding [Circe] and [Monocle] versions.

| Circe Optics | Circe | Monocle | Scala 2 | Scala 3 | Scala JVM | Scala.JS |
|------------------|--------|---------|---------|---------|-----------|----------|
| 0.15.0 and later | 0.14.x | 3.x |||||
| 0.14.1 | 0.14.x | 2.x |||||

## Contributors and participation

This project supports the Scala [code of conduct][code-of-conduct] and we want
Expand All @@ -31,8 +42,13 @@ See the License for the specific language governing permissions and
limitations under the License.

[apache]: http://www.apache.org/licenses/LICENSE-2.0

[api-docs]: https://circe.github.io/circe-optics/api/io/circe/

[circe]: https://github.com/circe/circe

[code-of-conduct]: https://www.scala-lang.org/conduct.html

[contributing]: https://circe.github.io/circe/contributing.html

[monocle]: https://github.com/optics-dev/Monocle

0 comments on commit dfa11de

Please sign in to comment.