From 72d451679579c97b8f1715f9b6500e1877f49dae Mon Sep 17 00:00:00 2001 From: Jamie Willis Date: Wed, 21 Dec 2022 21:03:20 +0000 Subject: [PATCH] Updated readme --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index de7c64d..c6e6e5a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ may be generally recursive, just slow). ## How do I use it? [![parsley-cats Scala version support](https://index.scala-lang.org/j-mie6/parsley-cats/parsley-cats/latest-by-scala-version.svg?platform=jvm)](https://index.scala-lang.org/j-mie6/parsley-cats/parsley-cats) [![parsley-cats Scala version support](https://index.scala-lang.org/j-mie6/parsley-cats/parsley-cats/latest-by-scala-version.svg?platform=sjs1)](https://index.scala-lang.org/j-mie6/parsley-cats/parsley-cats) [![parsley-cats Scala version support](https://index.scala-lang.org/j-mie6/parsley-cats/parsley-cats/latest-by-scala-version.svg?platform=native0.4)](https://index.scala-lang.org/j-mie6/parsley-cats/parsley-cats) -Parsley is distributed on Maven Central, and can be added to your project via: +Parsley cats is distributed on Maven Central, and can be added to your project via: ```scala libraryDependencies += "com.github.j-mie6" %% "parsley-cats" % "0.1.0" @@ -17,10 +17,20 @@ libraryDependencies += "com.github.j-mie6" %% "parsley-cats" % "0.1.0" it requires `parsley` and `cats-core` to also be dependencies of your project. The current version matrix for `parsley-cats`: -* `0.1.0` supports `4 <= parsley < 5` , `2.8 <= cats-core < 3` +| `parsley-cats` version | `parsley` version | `cats-core` version | +| :--------------------: | :---------------: | :-----------------: | +| `0.1.0` | `>= 4 && < 5` | `>= 2.8 && < 3` | Documentation can be found [**here**][Link-Scaladoc] +## What is `parsley`? + +[Parsley](https://github.com/j-mie6/parsley) is a fast, modern, parser combinator library based loosely on Haskell's `parsec` and +`megaparsec`. For examples, see its repo and wiki! + + +