Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
noamr committed Jan 3, 2024
1 parent 5bc52fe commit cc996ff
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,24 @@ A small JS library that implements common patterns on top of CSS view-transition
* Respond to navigations
* Animate between list and details

## To install
```bash
npm install velvette
```
```js
import {Velvette, startViewTransition} from "velvette";
```

Or directly in the browser:
```html
<script src="https://www.unpkg.com/velvette@0.1.6/dist/browser/velvette.js">
<script>
// You now have `Velvette` in your window object.
Velvette.startViewTransition(...)
const velvette = new Velvette(config);
</script>
```

## Overview

### CSS View Transitions
Expand Down

0 comments on commit cc996ff

Please sign in to comment.