Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexanderdunlop committed Apr 10, 2019
1 parent 2773e73 commit 053977c
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 4 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ storybook-static

*.html

*.md
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,43 @@
# react-load-animations

[![npm version](https://badge.fury.io/js/react-load-animations.svg)](https://badge.fury.io/js/react-load-animations)
[![Build Status](https://travis-ci.org/Alexanderdunlop/react-load-animations.svg?branch=master)](https://travis-ci.org/Alexanderdunlop/react-load-animations)
[![Coverage Status](https://coveralls.io/repos/github/Alexanderdunlop/react-load-animations/badge.svg?branch=master)](https://coveralls.io/github/Alexanderdunlop/react-load-animations?branch=master)

React loading animations using css
React loading animations using css. See [demo](https://alexanderdunlop.github.io/react-load-animations/)

## Installation

### npm

```sh
npm i react-load-animations
```

### yarn

```sh
yarn add react-load-animations
```

### unpkg

```html
<script src="https://unpkg.com/react-load-animations@latest/dist/bundle.umd.js"></script>
```

## Usage

```js
import { Ellipsis } from 'react-load-animations'
```

## Examples

- [UMD via CDN](./examples/cdn)
- [Create-React-App](./examples/cra)
- [Server-Side Rendering](./examples/ssr)

## Copyright

Ellipsis, Ring, Ripple from [loading.io](https://loading.io)
2 changes: 1 addition & 1 deletion examples/cdn/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<div id='container'></div>
<script crossorigin src="https://unpkg.com/react@16/umd/react.production.min.js"></script>
<script crossorigin src="https://unpkg.com/react-dom@16/umd/react-dom.production.min.js"></script>
<script src="./node_modules/react-load-animations/dist/bundle.umd.js"></script>
<script src="https://unpkg.com/react-load-animations@1.0.0/dist/bundle.umd.js"></script>
<script>
const { Ellipsis, Ring, Ripple } = window.ReactLoadAnimations
const container = document.getElementById('container')
Expand Down
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
"main": "dist/bundle.cjs.js",
"module": "dist/bundle.esm.js",
"sideEffects": false,
"files": [
"dist"
],
"scripts": {
"prebuild": "rimraf dist",
"build": "rollup -c",
Expand All @@ -18,7 +21,8 @@
"storybook": "start-storybook -p 9001 -c .storybook",
"storybook:build": "build-storybook -c .storybook",
"predeploy": "yarn storybook:build",
"deploy": "gh-pages -d storybook-static"
"deploy": "gh-pages -d storybook-static",
"prepublishOnly": "yarn build"
},
"husky": {
"hooks": {
Expand All @@ -43,7 +47,7 @@
"animations",
"spinners"
],
"author": "Alexanderdunlop <alex.dunlop@orbba.com>",
"author": "Alexanderdunlop <alexjamesdunlop@gmail.com>",
"license": "MIT",
"bugs": {
"url": "https://github.com/Alexanderdunlop/react-load-animations/issues"
Expand Down

0 comments on commit 053977c

Please sign in to comment.