Skip to content

Commit cc996ff

Browse files
committed
Update README
1 parent 5bc52fe commit cc996ff

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,24 @@ A small JS library that implements common patterns on top of CSS view-transition
1111
* Respond to navigations
1212
* Animate between list and details
1313

14+
## To install
15+
```bash
16+
npm install velvette
17+
```
18+
```js
19+
import {Velvette, startViewTransition} from "velvette";
20+
```
21+
22+
Or directly in the browser:
23+
```html
24+
<script src="https://www.unpkg.com/[email protected]/dist/browser/velvette.js">
25+
<script>
26+
// You now have `Velvette` in your window object.
27+
Velvette.startViewTransition(...)
28+
const velvette = new Velvette(config);
29+
</script>
30+
```
31+
1432
## Overview
1533

1634
### CSS View Transitions

0 commit comments

Comments
 (0)