Skip to content

Commit

Permalink
More README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
keynmol committed Feb 10, 2024
1 parent 31c96d3 commit 3e4a47a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Expand Up @@ -13,6 +13,11 @@ have an experience similar to that of [Insta](https://insta.rs/docs/cli/) with
its Cargo integration. Currently only SBT is supported, but Mill support
can be added easily, as the project is already structured in a way that favours that.

One of the goals was being able to work with Scala.js and Scala Native - so the Scala.js portion of the runtime includes small Node.js bindings
to the `fs` module for filesystem operations.

The runtime is published for 2.12, 2.13, 3 and JVM, JS, Native.


## Installation (SBT)
To add the plugin to your SBT build:
Expand Down Expand Up @@ -48,4 +53,12 @@ At this point there is no OOTB test framework integrations, but they will come i
[Sample MUnit integration](modules/example/src/test/scala/MunitSnapshotsIntegration.scala) |
[Sample MUnit tests](modules/example/src/test/scala/MunitExampleTests.scala)

You can see what the workflow looks like by

1. Modifying the sample test above
2. Running `example/test` and observing a failure
3. Running `example/snapshotsCheck` and accepting a diff
4. Running `example/test` again and it should succeed
5. The snapshot file will be changed on disk


0 comments on commit 3e4a47a

Please sign in to comment.