Skip to content

Correct Name and Add npm Install Examples #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Correct Name and Add npm Install Examples #66

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3875d0a
Correct Create-React-App Name
Koolstr Feb 20, 2018
59e4746
Add npm install examples
Koolstr Feb 20, 2018
7338aee
Adjust npm install example format
Koolstr Feb 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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

Expand All @@ -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 <path/to/json>` 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:

Expand Down