add examples readme and add title to example apps

This commit is contained in:
Rene Haas
2022-11-25 11:52:55 +01:00
parent a89d4a7921
commit 2122378a5e
6 changed files with 39 additions and 16 deletions
+24
View File
@@ -0,0 +1,24 @@
# Examples
Run example applications with `OverlayScrollbars`.
> __Note__: All commands must be executed from the root directory of the repository unless stated differently.
## Install and Build
Before you can start any application you have to install all dependencies and build the library:
1. `npm i`
2. `npm run build:os`
## Run Example
The following examples are available:
| App | Command |
| :--- | :--- |
| React | `npm run example:react` |
| Vue | `npm run example:vue` |
| Angular | `npm run example:ngx` |
| Svelte | `npm run example:svelte` |
| Solid | `npm run example:solid` |