Skip to content

Commit

Permalink
chore[wip]: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
svenjacobs committed Sep 18, 2023
1 parent e80fe51 commit d887f66
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Reveal effect (also known as coach mark, onboarding, tutorial, walkthrough, etc.) with a beautiful
API for [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/).
API for [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) targeting
Android, iOS, desktop and Web.

![Demonstration](./assets/demo.gif)

Expand All @@ -13,6 +14,16 @@ API for [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatfo

## Getting started

### Compose Multiplatform

As of version `3.0` Reveal is based on Compose Multiplatform targeting Android, iOS, desktop and
Web. However please not that except Android the other platforms are currently not well tested and
some of the targets are still alpha or experimental.

When using Reveal on Android, please make sure that the version of Google's Jetpack Compose is
compatible with the version of Compose Multiplatform that Reveal uses, which you can
find [here](./gradle/libs.versions.toml#L5).

### Installation

The minimum supported Android SDK is 21 (Android 5.0), which is a requirement of Jetpack Compose.
Expand Down

0 comments on commit d887f66

Please sign in to comment.