Skip to content

Commit aa0cb6e

Browse files
committed
docs(readme): add short description
1 parent 6369072 commit aa0cb6e

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

Diff for: README.md

+27
Original file line numberDiff line numberDiff line change
@@ -1 +1,28 @@
11
# Material UI theme editor
2+
3+
## What is it made for?
4+
5+
I'm a developer that loves to work with [MaterialUI](https://material-ui.com/) but it generates always the same looking websites.
6+
That's when a designer arrives and tell you "You've to use this color, and this color...", and it's a pain to integrate, you cannot make
7+
it fit with your MaterialUI theme, etc, just because your designer isn't really aware of what you use and what are the limits.
8+
9+
So now, give this website to your designer, and wait for him to give you the theme file. And then, to integrate it, you just have to do
10+
the following
11+
12+
```javascript
13+
import React from 'react';
14+
import ReactDOM from 'react-dom';
15+
import { createMuiTheme, MuiThemeProvider } from '@material-ui/core/styles';
16+
import Application from './your/entry/point';
17+
import yourRawTheme from './wherever/is/your/theme.json';
18+
19+
const theme = createMuiTheme(yourRawTheme);
20+
21+
ReactDOM.render(
22+
<MuiThemeProvider theme={theme}>
23+
<Application />
24+
</MuiThemeProvider>
25+
, document.getElementById('root'));
26+
```
27+
28+
And BOOOM! You have a nice theme, you designer is happy, and you didn't fight with him/her...

0 commit comments

Comments
 (0)