Skip to content

Commit e66acab

Browse files
authored
Improve readme
1 parent 4e2c82d commit e66acab

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,49 +21,58 @@
2121
- [Become a backer or sponsor on Patreon](https://www.patreon.com/arturbien).
2222
- [One-time donation via PayPal](https://www.paypal.me/react95)
2323

24+
## Motivation
25+
Create modern mobile/web applications with the retro and old school Windows 95 style. Our goal is not to exactly recreate Windows95 components, but to provide a solid component library for current scenarios.
2426

2527
## Getting Started
2628
First, install component library and styled-components in your project directory:
2729
```sh
28-
$ npm i react95 styled-components
30+
// yarn
31+
yarn react95 styled-components
32+
33+
// npm
34+
npm i react95 styled-components
2935
```
3036
Apply style reset, wrap your app content with ThemeProvider with theme of your choice... and you are ready to go! 🚀
3137
```jsx
32-
import React from "react";
33-
import { createGlobalStyle, ThemeProvider } from "styled-components";
34-
import { reset, themes, List, ListItem, Divider } from "react95";
38+
import React from 'react';
39+
import { createGlobalStyle, ThemeProvider } from 'styled-components';
40+
import { reset, themes, List, ListItem, Divider } from 'react95';
3541

3642
const ResetStyles = createGlobalStyle`
3743
${reset}
3844
`;
3945

40-
export default props =>
41-
<div className="App">
46+
const App = () => (
47+
<div>
4248
<ResetStyles />
4349
<ThemeProvider theme={themes.default}>
4450
<List>
45-
<ListItem>🎤 Sing</ListItem>
46-
<ListItem>💃🏻 Dance</ListItem>
47-
<Divider />
48-
<ListItem disabled>😴 Sleep</ListItem>
51+
<ListItem>🎤 Sing</ListItem>
52+
<ListItem>💃🏻 Dance</ListItem>
53+
<Divider />
54+
<ListItem disabled>😴 Sleep</ListItem>
4955
</List>
5056
</ThemeProvider>
5157
</div>
52-
58+
);
59+
60+
export default App;
5361
```
5462

5563
### Explore
5664
You can view components on [Storybook](https://arturbien.github.io/React95/). If you want to play with it locally, simply clone the repo and run commands below:
65+
5766
```sh
58-
$ npm i
59-
$ npm run storybook
67+
$ yarn
68+
$ yarn storybook
6069
```
70+
6171
### Submit your project
6272
Apps built with React95 will be submitted on the official React95 [website](https://react95.io) 🤟🏻
6373

6474
### Contributing
65-
**We are not attempting to exactly RECREATE Windows95 components. We are going to make them usable in the modern mobile / web apps.
66-
Thus, any help from UI / UX designers would be EXTREMELY appreciated. The challenge is to come up with new component designs / layouts that are broadly used in modern UIs, that weren't present back in 95.**
75+
Any help from UI / UX designers would be EXTREMELY appreciated. The challenge is to come up with new component designs / layouts that are broadly used in modern UIs, that weren't present back in 95.
6776

6877
There's a lot to do. If you want to help with the project, feel free to open pull requests and submit issues. Let's make UI great again 🔥
6978

@@ -80,4 +89,3 @@ There's quite a few things to be done:
8089
And the boring stuff too:
8190
- Testing
8291
- Semantic release
83-
- eslint

0 commit comments

Comments
 (0)