diff --git a/README.md b/README.md index 63f36eb51..5a0bbb26e 100644 --- a/README.md +++ b/README.md @@ -1 +1,28 @@ -# Teamleader UI \ No newline at end of file +# Teamleader UI + +Teamleader UI is a set of [React](http://facebook.github.io/react/) components used in Teamleader. + +## Installation + +Teamleader UI can be installed as an [npm package](https://www.npmjs.com/package/teamleader-ui): + +```bash +$ npm install --save teamleader-ui +``` + +## Basic usage + +In this minimal example, we import a `Button` with styles already bundled: + +```js +import React from 'react'; +import { Button } from 'teamleader-ui'; + +render( +