Skip to content

Commit

Permalink
Update README (#271)
Browse files Browse the repository at this point in the history
* Update README

* Add note about Scala 3

* One more version
  • Loading branch information
travisbrown authored Jun 4, 2021
1 parent 5fc8852 commit 55fb97f
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,18 @@ into JVM build systems (see the [dhall-kubernetes] demonstration
The core modules have no external dependencies, are Java 7-compatible, and are fairly minimal:

```bash
$ du -h modules/core/target/dhall-core-0.4.1-SNAPSHOT.jar
148K modules/core/target/dhall-core-0.4.1-SNAPSHOT.jar
$ du -h modules/core/target/dhall-core-0.9.0-M2.jar
160K modules/core/target/dhall-core-0.9.0-M2.jar

$ du -h modules/parser/target/dhall-parser-0.4.1-SNAPSHOT.jar
104K modules/parser/target/dhall-parser-0.4.1-SNAPSHOT.jar
$ du -h modules/parser/target/dhall-parser-0.9.0-M2.jar
104K modules/parser/target/dhall-parser-0.9.0-M2.jar
```

There are also several [Scala][scala] modules that are published for Scala 2.12
and 2.13. While most of the examples in this README are focused on Scala, you
There are also several [Scala][scala] modules that are published for Scala 2.12,
2.13, and 3.0. While most of the examples in this README are focused on Scala, you
shouldn't need to know or care about Scala to use the core DhallJ modules.

This project has been supported in part by [Permutive][permutive]. Please see our
[monthly reports][permutive-medium] for updates on the work of the Permutive Community Engineering
team.
The initial development of this project was supported in part by [Permutive][permutive].

## Table of contents

Expand All @@ -43,10 +41,10 @@ team.

## Status

The current release of this project supports [Dhall 17.0.0][dhall-17].
The current release of this project supports [Dhall 20.2.0][dhall-20-2-0].
We're running the [Dhall acceptance test suites][dhall-tests] for parsing, normalization,
[CBOR][cbor] encoding and decoding, hashing, and type inference, and
currently all tests are passing.
currently all tests are passing (with one exception; see the [0.9.0-M2 release notes for details](https://github.com/travisbrown/dhallj/releases/tag/v0.9.0-M2)).

There are several known issues:

Expand All @@ -64,7 +62,7 @@ The easiest way to try things out is to add the Scala wrapper module to your bui
If you're using [sbt][sbt] that would look like this:

```scala
libraryDependencies += "org.dhallj" %% "dhall-scala" % "0.4.0"
libraryDependencies += "org.dhallj" %% "dhall-scala" % "0.9.0-M2"
```

This dependency includes two packages: `org.dhallj.syntax` and `org.dhallj.ast`.
Expand Down Expand Up @@ -693,6 +691,7 @@ Copyright [Travis Brown][travisbrown] and [Tim Spence][timspence], 2020.
[circe]: https://github.com/circe/circe
[code-of-conduct]: https://www.scala-lang.org/conduct/
[dhall-17]: https://github.com/dhall-lang/dhall-lang/releases/tag/v17.0.0
[dhall-20-2-0]: https://github.com/dhall-lang/dhall-lang/releases/tag/v20.2.0
[dhall-haskell]: https://github.com/dhall-lang/dhall-haskell
[dhall-imports]: https://github.com/dhall-lang/dhall-lang/blob/master/standard/imports.md
[dhall-json]: https://docs.dhall-lang.org/tutorials/Getting-started_Generate-JSON-or-YAML.html
Expand Down

0 comments on commit 55fb97f

Please sign in to comment.