Skip to content

Commit

Permalink
proper README
Browse files Browse the repository at this point in the history
  • Loading branch information
David Inga committed Feb 16, 2017
1 parent f3a1d86 commit 4945c3f
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
# Vizzuality components

Vizzuality components is a collection of React components to make visualisations.
Vizzuality components is a collection of React components that we use in our projects.

## Installation
## Components

* [Globe](./components/Globe): A 3D earth with controls, zoom and animation. It uses WebGL and three.js.
* [Spinner](./components/Spinner): Spinner is a Icon that, well, spins.

## How to use

You need to have configured nodejs and npm before, then you can install using this command:

```bash
npm install --save vizz-components
```

Example using ES6:

```js
import React from 'react';
import { Spinner } from 'vizz-components';

class MyView extends React.Component {
render() {
return (
<Spinner />
);
}
}
```

## Contribution

If you want to contribute to this project adding new React components, just follow this simple instructions:
Expand All @@ -18,3 +41,7 @@ If you want to contribute to this project adding new React components, just foll
* Add your component story inside `stories/index.js` file
* Run the storybook with `npm start`
* Send us a pull-request with your awesome component :)

## License

Vizzuality Components is freely distributable under the terms of the [MIT license](LICENSE.md).

0 comments on commit 4945c3f

Please # to comment.