diff --git a/README.md b/README.md index 364bfa8..eeba80c 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,9 @@ A command line tool to help you extract [react-toolbox](http://react-toolbox.com ``` $ yarn add --dev react-toolbox-themr react-toolbox@2.0.0-beta.6 ``` +``` +$ npm install --dev react-toolbox-themr react-toolbox@2.0.0-beta.6 +``` Note it only works with **React Toolbox 2.0 beta**. The output path shown in the GIF is outdated, now by default the assets are generated at `src/toolbox`. @@ -18,7 +21,7 @@ Note it only works with **React Toolbox 2.0 beta**. The output path shown in the [React Toolbox 2.0](https://github.com/react-toolbox/react-toolbox/releases) styles have been rewritten using [postcss](https://github.com/postcss/postcss). This gives us more flexibility and makes the library more powerful allowing things like live transforming in the browser. We still use [CSS Modules](https://github.com/css-modules/css-modules) thought, and some people find difficult to integrate the library in their current stack, specially when [Webpack](https://webpack.github.io/) is not included or accessible. -Sometimes it's annoying to configure react-toolbox to import CSS so this package will help you making easier to try out the library and providing an easy integration with tools like [react-create-app](https://github.com/facebookincubator/create-react-app). It will help you extracting the CSS modules into static files you can import in your application, making react-toolbox very easy to adopt. +Sometimes it's annoying to configure react-toolbox to import CSS so this package will help you making easier to try out the library and providing an easy integration with tools like [Create-React-App](https://github.com/facebookincubator/create-react-app). It will help you extracting the CSS modules into static files you can import in your application, making react-toolbox very easy to adopt. ## Usage @@ -27,6 +30,9 @@ First of all you have to add `react-toolbox-themr` to your project as a developm ``` $ yarn add --dev react-toolbox-themr ``` +``` +$ npm install --dev react-toolbox-themr +``` Once installed you can define the configuration in the `package.json` file of your project or through the `--config ` option. If you want to use your `package.json` to store configuration, the `reactToolbox` key should be used on the top level to find your settings: