diff --git a/README.md b/README.md index 5a5f5a6..a086be8 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,13 @@ val testEffect = ZIO.unit val testEffect = CostCenter.withChildCostCenter("foo.Foo.testEffect(Foo.scala:12)")(ZIO.unit) ``` +To enable the compiler plugin, add the following to the sbt module __containing the code you want to profile__. + +```scala +compilerPlugin("dev.zio" %% "zio-profiling-tagging-plugin" % "0.1.2") + +``` + ## Jmh Support ZIO Profiling offers an integration with the Java Microbenchmark Harness (JMH). In order to profile a jmh benchmark, first ensure that the sources are properly tagged using the tagging plugin. Next, add a dependency to the jmh module to your benchmarking module: diff --git a/docs/index.md b/docs/index.md index 101a4db..996bd63 100644 --- a/docs/index.md +++ b/docs/index.md @@ -128,6 +128,13 @@ val testEffect = ZIO.unit val testEffect = CostCenter.withChildCostCenter("foo.Foo.testEffect(Foo.scala:12)")(ZIO.unit) ``` +To enable the compiler plugin, add the following to the sbt module __containing the code you want to profile__. + +```scala +compilerPlugin("dev.zio" %% "zio-profiling-tagging-plugin" % "@VERSION@") + +``` + ## Jmh Support ZIO Profiling offers an integration with the Java Microbenchmark Harness (JMH). In order to profile a jmh benchmark, first ensure that the sources are properly tagged using the tagging plugin. Next, add a dependency to the jmh module to your benchmarking module: