Skip to content

Commit

Permalink
Improve annotations explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidbilik
davidbilik committed Nov 22, 2024
1 parent 8cdfdea commit 464a3e5
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,10 @@ The library supports two main testing strategies:
- Perfect for testing complete screens and layouts within a device frame

To determine on a Preview level which strategy to use the predefined
annotation metadata tag can be used along the `ShowkaseComposable` annotation which serves
as a substitute for a @Preview annotation with some additional properties.
annotation metadata tag can be used along the `ShowkaseComposable` annotation. Showkase collects
both `@Preview` and `@ShowkaseComposable` methods, but only the latter can be used to specify the strategy.
In the following example `@Preview` is used to render the component in Android Studio and `@ShowkaseComposable`
for the snapshots.

```kotlin
@Preview
Expand Down

0 comments on commit 464a3e5

Please sign in to comment.