diff --git a/LICENSE b/LICENSE index 308b3e45..98ece9eb 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015 Javi Jiménez +Copyright (c) 2015 React Toolbox Team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 2cac9de7..f60e7ec6 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,73 @@ [![Build Status](https://travis-ci.org/react-toolbox/react-toolbox.svg?branch=master)](https://travis-ci.org/react-toolbox/react-toolbox) [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/soyjavi/react-toolbox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -React-Toolbox is a set of React components that implement Google's Material Design specification. - *Current version: [0.7.29]()* + +React Toolbox is a set of [React](http://facebook.github.io/react/) components that implement [Google's Material Design specification](https://www.google.com/design/spec/material-design/introduction.html). It's powered by [CSS Modules](https://github.com/css-modules/css-modules) and integrates harmfully with your [Webpack](http://webpack.github.io/) workflow. You can take a tour through our documentation website and try the components live! + +## Installation + +React Toolbox can be installed as an [npm package](https://www.npmjs.org/package/material-ui); + +``` +npm install --save react-toolbox +``` + +## Usage + +Although there are other ways to use React Toolbox, the recommended way is to create a Webpack workflow with [Babel Loader](https://github.com/babel/babel-loader), [CSS Loader](https://github.com/webpack/css-loader) and [SASS Loader](https://github.com/jtangelder/sass-loader). A good starting point is [React Hot Webpack Boilerplate](https://github.com/gaearon/react-hot-boilerplate). + +Once you have the workflow ready, you can just require and use the components: + +```jsx +import React from 'react'; +import Button from 'react-toolbox/button'; + +const Button = () => ( +