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

Commit

Permalink
📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nickwaelkens committed Apr 7, 2017
1 parent 30238c8 commit 79300e6
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Teamleader UI

Teamleader UI is a set of [React](http://facebook.github.io/react/) components used in Teamleader.
Teamleader UI is a set of [React](http://facebook.github.io/react/) components that implement the [Teamleader](https://www.teamleader.eu) design specification.

## Installation

Expand All @@ -16,13 +16,32 @@ In this minimal example, we import a `Button` with styles already bundled:

```js
import React from 'react';
import ReactDOM from 'react-dom';
import { Button } from 'teamleader-ui';

render(
<Button label="Hello World!" />
ReactDOM.render(
<Button label="Hello World!" />,
document.getElementById('app')
);
```

## Contributing

To work in the project you will need a node version supporting ES6 syntax. Although the project is built using the Babel compiler, we use some ES6 features on the development server. Consider using [n](https://github.com/tj/n) or [nvm](https://github.com/creationix/nvm) to handle different node versions!

To start the spec site locally, follow these simple steps:

```bash
$ git clone https://github.com/teamleadercrm/teamleader-ui
$ cd teamleader-ui/
$ npm i
$ npm start
```

Open up a browser and the local spec will be available at [http://localhost:3000/](http://localhost:3000/).



## 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 79300e6

Please sign in to comment.