Skip to content

Commit

Permalink
Merge pull request #115 from ncoden/docs/improve-readme
Browse files Browse the repository at this point in the history
docs: improve README.md design and installation section
  • Loading branch information
ncoden authored May 23, 2018
2 parents 5bd0efa + 1a2fbb8 commit 1a1c846
Showing 1 changed file with 41 additions and 5 deletions.
46 changes: 41 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,52 @@
# Motion UI
<p align="center">
<a href="https://zurb.com/playground/motion-ui">
<img src="https://user-images.githubusercontent.com/9939075/40385796-108879b6-5e08-11e8-8a12-3bbe7d0bc631.png" alt="Motion UI" width="448px" style="max-width:100%;"/>
</a>
</p>




<p align="center">
<a href="https://github.com/zurb/motion-ui/blob/docs/installation.md"><b>Install</b></a>
| <a href="https://zurb.com/playground/motion-ui">Demo</a>
| <a href="https://github.com/zurb/motion-ui/blob/docs">Documentation</a>
| <a href="https://github.com/zurb/motion-ui/releases">Releases</a>
</p>

---


[![Build Status](https://travis-ci.org/zurb/motion-ui.svg?branch=develop)](https://travis-ci.org/zurb/motion-ui)
[![CDNJS](https://img.shields.io/cdnjs/v/motion-ui.svg)](https://cdnjs.com/libraries/motion-ui/)
[![dependencies Status](https://david-dm.org/zurb/motion-ui/status.svg)](https://david-dm.org/zurb/motion-ui)
[![devDependencies Status](https://david-dm.org/zurb/motion-ui/dev-status.svg)](https://david-dm.org/zurb/motion-ui?type=dev)

A Sass library for creating CSS transitions and animations from your friends at [ZURB](http://zurb.com). Originally integrated into [Foundation for Apps](http://foundation.zurb.com/apps), the code is now a standalone library, soon to be used by [Foundation for Sites](http://foundation.zurb.com/sites) and Foundation for Apps.
💎 The powerful Sass library for creating CSS transitions and animations. Originally integrated into [Foundation for Apps](http://foundation.zurb.com/apps), the code is now a standalone library, used by [Foundation for Sites](http://foundation.zurb.com/sites) and Foundation for Apps. Made by your friends at [ZURB](http://zurb.com).

## Installation

- On npm: `npm install motion-ui`
- On Bower: `bower install motion-ui`
Install Motion UI with npm or Bower.

```
npm install motion-ui --save
bower install motion-ui --save
```

Then to build with **Sass** ([Autoprefixer](https://github.com/postcss/autoprefixer) is required):
```
// Add the load path "[modules_folder]/motion-ui/src" to your Sass configuration
@import 'motion-ui';
@include motion-ui-transitions;
@include motion-ui-animations;
```

Or to get the equivalent pre-compiled classes, import the Motion UI standalone **CSS** file `dist/motion-ui.css` or `dist/motion-ui.min.css`.

To easily transition elements in and out using Motion UI classes, import the Motion UI **JavaScript** library `dist/motion-ui.js` or `dist/motion-ui.min.js`.

See full [installation instructions](docs/installation.md)

## Demos

Expand All @@ -29,6 +65,6 @@ npm install
```

- Run `npm start` to compile test Sass/JS files, and to build the documentation.
- **To make changes to the documentation, edit the files under `docs/src`.
To make changes to the documentation, edit the files under `docs/src`.
- Run `npm test` to run the unit tests.
- Run `npm start dist` to compile distribution files.

0 comments on commit 1a1c846

Please sign in to comment.