deja-vue 1.0.1 → 2.1.0

package/README.md

@@ -1,33 +1,61 @@
 # Déjà Vue
 
-Declarative GSAP Animations for Vue 3.
+Declarative GSAP animations for Vue 3.
 
-## Documentation
+Déjà Vue lets you compose GSAP tweens and timelines with Vue components, so
+animation logic can live next to the markup it animates.
 
-View the [full documentation here](https://fiadone.github.io/deja-vue/).
+## Documentation
 
-## Development
+View the [documentation](https://fiadone.github.io/deja-vue/docs/) or explore
+the [landing page](https://fiadone.github.io/deja-vue/).
 
-- Install dependencies:
+## Install
 
 ```bash
-npm install
+npm install deja-vue gsap
+```
+
+`vue` and `gsap` are peer dependencies. This library targets Vue 3.
+
+## Usage
+
+```html
+<script setup lang="ts">
+import { Tween } from 'deja-vue'
+</script>
+
+<template>
+  <Tween :from="{ opacity: 0, y: 24, duration: 0.6, ease: 'power3.out' }">
+    <h1>
+      Animated
+      with
+      Déjà
+      Vue
+    </h1>
+  </Tween>
+</template>
 ```
 
-- Run the playground:
+Use `Tween` for single animations, `Timeline` to coordinate sequences,
+`Marker` for timeline checkpoints, and `SplitText` for text-based effects.
+
+## Development
+
+Install dependencies from the repository root:
 
 ```bash
-npm run playground
+npm install
 ```
 
-- Run the unit tests:
+Build the library package:
 
 ```bash
-npm run test
+npm run build -w deja-vue
 ```
 
-- Build the library:
+Run library type checks:
 
 ```bash
-npm run build
+npm run typecheck -w deja-vue
 ```