diff --git a/docs/index.md b/docs/index.md index ebfda99..957af99 100644 --- a/docs/index.md +++ b/docs/index.md @@ -53,7 +53,13 @@ object Hello extends IOApp.Simple { ``` @:@ -[Scala CLI]: https://scala-cli.virtuslab.org/ +### Native Image + +When building GraalVM Native Image the --no-fallback option is required, otherwise native-image will try searching +a static reflection configuration for [this Enumeration method]. Thus using this flag is safe only if you're not using +Enumerations in your codebase, see [this comment] for more info. + +[Scala CLI]: https://scala-cli.virtuslab.org/_ [Scala Toolkit]: https://github.com/VirtusLab/toolkit [Cats]: https://typelevel.org/cats [Cats Effect]: https://typelevel.org/cats-effect @@ -63,4 +69,7 @@ object Hello extends IOApp.Simple { [Http4s Ember Client]: https://http4s.org/v0.23/docs/client.html [Circe]: https://circe.github.io/circe/ [Decline Effect]: https://ben.kirw.in/decline/effect.html -[Munit Cats Effect]: https://github.com/typelevel/munit-cats-effect \ No newline at end of file +[Munit Cats Effect]: https://github.com/typelevel/munit-cats-effect + +[this Enumeration method]: https://github.com/scala/scala/blob/v2.13.8/src/library/scala/Enumeration.scala#L190-L215= +[this comment]: https://github.com/typelevel/cats-effect/issues/3051#issuecomment-1167026949 \ No newline at end of file