Skip to content

Commit e321493

Browse files
committed
Merge branch 'master' of github.com:arturbien/React95 into develop
2 parents 1b636b5 + dd99cab commit e321493

File tree

1 file changed

+42
-19
lines changed

1 file changed

+42
-19
lines changed

README.md

Lines changed: 42 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/dt/react95" alt="NPM"></a>
55
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/v/react95" alt="React95 version"></a>
66
<a href="https://www.npmjs.com/package/react95"><img src="https://flat.badgen.net/npm/license/react95" alt="React95 license"></a>
7-
7+
88
</p>
99
<h3 align="center">
1010
<a href="https://arturbien.github.io/React95/?path=/story/select--fixed-width">Components</a> -
@@ -14,61 +14,84 @@
1414
</h3>
1515
<p align="center">
1616
<b>Refreshed</b> Windows95 UI components for your modern React apps. <br> Built with styled-components 💅</p>
17-
17+
1818
![demo](https://user-images.githubusercontent.com/28541613/56099388-7513f800-5f0c-11e9-893b-532eded39f92.png)
1919

2020
### Support
21+
2122
- [Become a backer or sponsor on Patreon](https://www.patreon.com/arturbien).
2223
- [One-time donation via PayPal](https://www.paypal.me/react95)
2324

25+
## Motivation
26+
27+
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.
2428

2529
## Getting Started
26-
First, install component library and styled-components in your project directory:
30+
31+
First, install component library and styled-components in your project directory:
32+
2733
```sh
34+
# yarn
35+
$ yarn react95 styled-components
36+
37+
# npm
2838
$ npm i react95 styled-components
2939
```
40+
3041
Apply style reset, wrap your app content with ThemeProvider with theme of your choice... and you are ready to go! 🚀
42+
3143
```jsx
32-
import React from "react";
33-
import { createGlobalStyle, ThemeProvider } from "styled-components";
34-
import { reset, themes, List, ListItem, Divider } from "react95";
44+
import React from 'react';
45+
import { createGlobalStyle, ThemeProvider } from 'styled-components';
46+
import { reset, themes, List, ListItem, Divider } from 'react95';
3547

3648
const ResetStyles = createGlobalStyle`
3749
${reset}
3850
`;
3951

40-
export default props =>
41-
<div className="App">
52+
const App = () => (
53+
<div>
4254
<ResetStyles />
4355
<ThemeProvider theme={themes.default}>
4456
<List>
45-
<ListItem>🎤 Sing</ListItem>
46-
<ListItem>💃🏻 Dance</ListItem>
47-
<Divider />
48-
<ListItem disabled>😴 Sleep</ListItem>
57+
<ListItem>🎤 Sing</ListItem>
58+
<ListItem>💃🏻 Dance</ListItem>
59+
<Divider />
60+
<ListItem disabled>😴 Sleep</ListItem>
4961
</List>
5062
</ThemeProvider>
5163
</div>
52-
64+
);
65+
66+
export default App;
5367
```
5468

5569
### Explore
70+
5671
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:
72+
5773
```sh
58-
$ npm i
59-
$ npm run storybook
74+
# yarn
75+
$ yarn && yarn storybook
76+
77+
# npm
78+
$ npm i && npm run storybook
6079
```
80+
6181
### Submit your project
82+
6283
Apps built with React95 will be submitted on the official React95 [website](https://react95.io) 🤟🏻
6384

6485
### 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.**
6786

68-
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 🔥
87+
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.
88+
89+
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 🔥
6990

7091
### Roadmap
92+
7193
There's quite a few things to be done:
94+
7295
- Styled system
7396
- Lots of tacky color schemes 🌈
7497
- Custom icons maybe? (Emojis from Windows 10 seem to go very well with the lib)
@@ -78,6 +101,6 @@ There's quite a few things to be done:
78101
- Components common in all modern UIs (FAB, Badge, Avatar, Snackbar, Steppers)
79102

80103
And the boring stuff too:
104+
81105
- Testing
82106
- Semantic release
83-
- eslint

0 commit comments

Comments
 (0)