Skip to content

Commit

Permalink
chore: small fix in readme (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
polentino committed Apr 1, 2024
1 parent 096e8ef commit f432114
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ in your `build.sbt` file, add the following lines

```scala 3
val redactedVersion = // use latest version of the library
resolvers += "Sonatype OSS Releases" at "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2"
resolvers += DefaultMavenRepository,
libraryDependencies ++= Seq(
"io.github.polentino" %% "redacted" % redactedVersion cross CrossVersion.full,
compilerPlugin("io.github.polentino" %% "redacted-plugin" % redactedVersion cross CrossVersion.full)
Expand Down Expand Up @@ -162,14 +162,7 @@ def toString(): String =

## Improvements

* [x] define the sequence of redacted fields in a private variable
* [x] move aforementioned variable in the case class companion object
* [x] figure out why doesn't work anymore with nested case classes
* [x] split into three artifacts (lib, compiler plugin and tests)
* [x] find a better alternative instead of using `managedSources`
* [x] refactor codebase
* [ ] create Sbt plugin
* [ ] publish library and compiler plugin to maven
* [ ] add some benchmarks with jmh

## Credits
Expand Down

0 comments on commit f432114

Please sign in to comment.