diff --git a/README.md b/README.md index 9bd0f86..6be4bbe 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Optimal +> **⚠️ This project is unmaintained.** +> **We recommend [NimbleOptions](https://github.com/dashbitco/nimble_options) instead.** + Optimal is a schema based `opt` validator. It is verbose, but I've tried many other data validation libraries, and their succinctness came with a cost when it came to features. There are still a lot of optimizations and improvements that can be made, so contributions are very welcome. This `opt` validator has a bit of a niche. It fits in just fine with validating any keyword list, but its especially useful for validating compile-time options, like ones provided to functions in a DSL.