@infinityfx/lively 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +40 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,7 +1,44 @@
1
1
  # Lively
2
2
 
3
- React animation library.
3
+ [![NPM package](https://img.shields.io/npm/v/@infinityfx/lively)](https://www.npmjs.com/package/@infinityfx/lively)
4
+ ![NPM bundle size](https://img.shields.io/bundlephobia/minzip/@infinityfx/lively)
5
+ ![Last commit](https://img.shields.io/github/last-commit/infinityfx-llc/lively)
6
+ ![NPM weekly downloads](https://img.shields.io/npm/dw/@infinityfx/lively)
7
+ ![NPM downloads](https://img.shields.io/npm/dt/@infinityfx/lively)
4
8
 
5
- ---
9
+ Lightweight, zero-configuration react animation library.
6
10
 
7
- ### Coming soon
11
+ ## Table of contents
12
+ - [Get started](#get-started)
13
+ - [Installation](#installation)
14
+ - [Usage](#usage)
15
+ - [Components](#components)
16
+
17
+ ## Get started
18
+
19
+ ### Installation
20
+
21
+ ```sh
22
+ $ npm i @infinityfx/lively
23
+ ```
24
+
25
+ ### Usage
26
+
27
+ ```jsx
28
+ import { Animate } from '@infinityfx/lively';
29
+
30
+ ...
31
+
32
+ <Animate onMount>
33
+ <div class="my-class">
34
+ Ullamco Lorem ipsum enim amet consequat ut reprehenderit cupidatat et incididunt qui minim culpa. Dolor do laborum nulla pariatur tempor excepteur duis et ipsum. Eu commodo et esse exercitation laborum cupidatat incididunt elit reprehenderit id.
35
+ </div>
36
+ </Animate>
37
+ ```
38
+
39
+ ## Components
40
+ - Animatable
41
+ - Animate
42
+ - Morph
43
+
44
+ More documentation coming soon!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@infinityfx/lively",
3
- "version": "0.0.6",
3
+ "version": "0.0.7",
4
4
  "description": "Zero configuration, performant react animation library",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",