Basic readme structure

Author: codepunkt

README.md

@@ -1,4 +1,47 @@
-# css-spring
-[![npm version](https://badge.fury.io/js/css-spring.svg)](https://badge.fury.io/js/css-spring) [![Build Status](https://travis-ci.org/codepunkt/css-spring.svg?branch=master)](https://travis-ci.org/codepunkt/css-spring) [![Coverage Status](https://coveralls.io/repos/github/codepunkt/css-spring/badge.svg?branch=master)](https://coveralls.io/github/codepunkt/css-spring?branch=master)
+# css-spring 🚀
+[![NPM Version](https://img.shields.io/npm/v/css-spring.svg?style=flat&label=NPM%20Version)](http://npm.im/css-spring)
+[![Build Status](https://img.shields.io/travis/codepunkt/css-spring.svg?style=flat&label=Build%20Status)](https://travis-ci.org/codepunkt/css-spring)
+[![Code Coverage](https://img.shields.io/coveralls/codepunkt/css-spring.svg?style=flat&label=Code%20Coverage)](https://coveralls.io/github/codepunkt/css-spring?branch=master)
+[![MIT License](https://img.shields.io/npm/l/css-spring.svg?style=flat&label=License)](http://opensource.org/licenses/MIT)
 
-Generates values for physics based css-keyframe animations
+Generates physics based css-keyframe animations.
+
+```javascript
+import spring, { format } from 'css-spring'
+
+const keyframes = spring(
+  { translate3d: 0 },
+  { translate3d: 250 },
+  { preset: 'wobbly', precision: 5 }
+)
+
+const moveLeft = format(
+  keyframes,
+  (k, v) => `transform: ${k}(${v} 0 0);`
+)
+```
+
+## TOC
+
+  - [Introduction](#introduction)
+  - [Examples](#examples)
+    - [styled-components](#styled-components)
+  - [API](#api)
+    - [spring(start, target, options)](#springstart-target-options)
+    - [format(keyframes, formatter)](#formatkeyframes-formatter)
+
+## Introduction
+
+Some introductory text
+
+## Examples
+
+Some example text
+
+### styled-components
+
+styled-components example
+
+## API
+### `spring(start, target, options)`
+### `format(keyframes, formatter)`

src/index.js

@@ -14,7 +14,7 @@ const defaults = {
   precision: 3,
 }
 
-export const getKeyframes = (startProps, targetProps, options = {}) => {
+export const spring = (startProps, targetProps, options = {}) => {
   const { stiffness, damping, precision } = Object.assign(
     {}, defaults, options,
     presets[options.preset] || {}
@@ -39,4 +39,4 @@ export const getKeyframes = (startProps, targetProps, options = {}) => {
 }
 
 export { default as format } from './format';
-export default getKeyframes
+export default spring