Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Commit

Permalink
Added some extra readme stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
driesd committed Feb 17, 2017
1 parent e854dee commit 4b10872
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
# Teamleader UI
# 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(
<Button label="Hello World!" />
);
```

## License

This project is licensed under the terms of the [MIT license](https://github.com/teamleadercrm/teamleader-ui/blob/master/LICENSE).

0 comments on commit 4b10872

Please sign in to comment.