Skip to content

Commit 6d839f6

Browse files
committed
chore: Update README.md
1 parent 20d852f commit 6d839f6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ dependencies {
2525

2626
#### Artifacts
2727

28-
| Name | Description |
28+
| Name | Description |
2929
|-----------------|-----------------------------------------|
3030
| `reveal-core` | Contains core classes. You need this 🙂 |
3131
| `reveal-shapes` | Additional shapes for explanatory items |
@@ -35,6 +35,8 @@ dependencies {
3535
The `Reveal` composable should be one of the top most composables in the hierarchy of your
3636
screen-level composable in order to access its scope. However it doesn't matter where in the
3737
component hierarchy the composable is added. The effect is always rendered fullscreen.
38+
You can have multiple `Reveal` instances in your UI hierarchy, for example per module or per
39+
screen. However it is recommended to only have one `Reveal` instance per screen.
3840

3941
```kotlin
4042
@Composable

0 commit comments

Comments
 (0)