Skip to content

Commit 4d3ae06

Browse files
authored
Update README.md
1 parent 0f45dfa commit 4d3ae06

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,24 @@ it's your Storybook with Material-UI components
2323
Start writing new stories from `src/stories/index.js` file.
2424
Create your app as an usual CRA app.
2525

26-
## About this boilerplate
26+
## Notes about this boilerplate
2727

28-
This project was created by these simple tools and steps:
28+
Create Material-UI App is built on top of [Create React App](https://github.com/facebook/create-react-app), which means all features that create-react-app supports are available.
29+
You can reproduce these steps to create everything from scratch or choose some of them to add needed tools to your existing project:
2930

3031
- `create-react-app` to create a project base
31-
- `getstorybook` to add a storybook to CRA project
32-
- `yarn add --dev storybook-addon-material-ui@next` to add support for material-ui
32+
- `getstorybook` to add a storybook to your CRA project
33+
- `yarn add --dev storybook-addon-material-ui@next` to add material-ui addon
3334
- `yarn add @material-ui/core` - install material-ui v1.xx
3435
- add `import 'storybook-addon-material-ui/register'` to `.storybook/addons.js`
3536
- add `import { muiTheme } from 'storybook-addon-material-ui';` to `src/stories/index.js`
3637
- add `.addDecorator(muiTheme())` to `src/stories/index.js`
3738

38-
So you can perform these steps manually to add `storybook-addon-material-ui` to your existing project. Or stick with this project since we trying to keep here the newest stable configuration.
39+
We recommend sticking with this boilerplate for new projects since we trying to keep here the newest stable configuration.
40+
41+
## CONTRIBUTING
42+
43+
Any feature requests, issues, PRs to this project are very welcome!
3944

4045
#### Credits
4146

0 commit comments

Comments
 (0)