Skip to content

Commit 21a3b6a

Browse files
committed
Minor tweaks on readme
1 parent e66acab commit 21a3b6a

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

Lines changed: 25 additions & 10 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,26 +14,32 @@
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

2425
## Motivation
26+
2527
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.
2628

2729
## Getting Started
28-
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+
2933
```sh
30-
// yarn
31-
yarn react95 styled-components
34+
# yarn
35+
$ yarn react95 styled-components
3236

33-
// npm
34-
npm i react95 styled-components
37+
# npm
38+
$ npm i react95 styled-components
3539
```
40+
3641
Apply style reset, wrap your app content with ThemeProvider with theme of your choice... and you are ready to go! 🚀
42+
3743
```jsx
3844
import React from 'react';
3945
import { createGlobalStyle, ThemeProvider } from 'styled-components';
@@ -61,23 +67,31 @@ export default App;
6167
```
6268

6369
### Explore
70+
6471
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:
6572

6673
```sh
67-
$ yarn
68-
$ yarn storybook
74+
# yarn
75+
$ yarn && yarn storybook
76+
77+
# npm
78+
$ npm i && npm run storybook
6979
```
7080

7181
### Submit your project
82+
7283
Apps built with React95 will be submitted on the official React95 [website](https://react95.io) 🤟🏻
7384

7485
### Contributing
86+
7587
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.
7688

77-
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 🔥
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 🔥
7890

7991
### Roadmap
92+
8093
There's quite a few things to be done:
94+
8195
- Styled system
8296
- Lots of tacky color schemes 🌈
8397
- Custom icons maybe? (Emojis from Windows 10 seem to go very well with the lib)
@@ -87,5 +101,6 @@ There's quite a few things to be done:
87101
- Components common in all modern UIs (FAB, Badge, Avatar, Snackbar, Steppers)
88102

89103
And the boring stuff too:
104+
90105
- Testing
91106
- Semantic release

0 commit comments

Comments
 (0)