Skip to content

Commit 7e02311

Browse files
committed
docs(readme): prepare README for v3 release
1 parent 9e2c82e commit 7e02311

File tree

2 files changed

+9
-45
lines changed

2 files changed

+9
-45
lines changed

README.md

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,22 @@
88

99
</p>
1010
<h3 align="center">
11-
<a href="https://arturbien.github.io/React95/?path=/story/select--fixed-width">Components</a> -
11+
<a href="https://storybook.react95.io/?path=/story/window--default">Components</a> -
12+
<a href="https://coins95.web.app/">Demo app</a> -
1213
<a href="https://react95.io/">Website</a> -
13-
<a href="https://join.slack.com/t/react95/shared_invite/enQtODExMzQ1Nzc2MjQ1LTMyNWVlYjllMzJhNTU3N2E2MDY1ZmM2ZTk3NzZkMjQ3YWIwMTlmNTZmMzc4OWU2MGVmYzZjMzNiNDI5NjgyMzA">Slack</a> -
14+
<a href="https://join.slack.com/t/react95/shared_invite/enQtOTA1NzEyNjAyNTc4LWYxZjU3NWRiMWJlMGJiMjhkNzE2MDA3ZmZjZDc1YmY0ODdlZjMwZDA1NWJiYWExYmY1NTJmNmE4OWVjNWFhMTE">Slack</a> -
1415
<a href="https://www.paypal.me/react95">PayPal donation 💰</a>
1516
</h3>
1617
<p align="center">
1718
<b>Refreshed</b> Windows95 UI components for your modern React apps. <br /> Built with styled-components 💅</p>
1819

19-
![demo](https://user-images.githubusercontent.com/28541613/56099388-7513f800-5f0c-11e9-893b-532eded39f92.png)
20+
![hero](https://user-images.githubusercontent.com/28541613/81947711-28b05580-9601-11ea-964a-c3a6de998496.png)
2021

2122
### Support
2223

23-
- [Become a backer or sponsor on Patreon](https://www.patreon.com/arturbien).
24+
- [Become a backer or sponsor on Patreon](https://www.patreon.com/arturbien)
2425
- [One-time donation via PayPal](https://www.paypal.me/react95)
2526

26-
## Motivation
27-
28-
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.
29-
3027
## Getting Started
3128

3229
First, install component library and styled-components in your project directory:
@@ -39,7 +36,7 @@ $ yarn react95 styled-components
3936
$ npm i react95 styled-components
4037
```
4138

42-
Apply style reset, wrap your app content with ThemeProvider with theme of your choice... and you are ready to go! 🚀
39+
Apply style reset, wrap your app with ThemeProvider with theme of your choice... and you are ready to go! 🚀
4340

4441
```jsx
4542
import React from 'react';
@@ -88,43 +85,13 @@ const App = () => (
8885
export default App;
8986
```
9087

91-
### Explore
92-
93-
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:
94-
95-
```sh
96-
# yarn
97-
$ yarn && yarn storybook
98-
99-
# npm
100-
$ npm i && npm run storybook
101-
```
102-
10388
### Submit your project
10489

105-
Apps built with React95 will be submitted on the official React95 [website](https://react95.io) 🤟🏻
90+
Apps built with React95 will be featured on the official React95 [website](https://react95.io) 🤟🏻
10691

10792
### Contributing
10893

10994
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.
11095

111-
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 🔥
112-
113-
For every component, we have a `.stories` file for Storybook and a `.mdx` file for Docz. In order to create a `.mdx` file we recommend copying [this template](https://github.com/arturbien/React95/blob/chore/docs-docz/docs/template) file and replaceing ___component_ with the component name.
114-
115-
### Roadmap
116-
117-
There's quite a few things to be done:
118-
119-
- Styled system
120-
- Lots of tacky color schemes 🌈
121-
- Custom icons maybe? (Emojis from Windows 10 seem to go very well with the lib)
122-
- Typography
123-
- Range slider component
124-
- Avatar component
125-
- Components common in all modern UIs (FAB, Badge, Avatar, Snackbar, Steppers)
126-
127-
And the boring stuff too:
96+
If you want to help with the project, feel free to open pull requests and submit issues or component proposals. Let's bring this UI back to life ♥️
12897

129-
- Testing
130-
- Semantic release

package.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
{
22
"name": "react95",
33
"version": "0.0.0-development",
4-
"authors": [
5-
"Artur Bień"
6-
],
74
"description": "Refreshed Windows95 UI components for modern web apps - React95",
85
"keywords": [
96
"react",
107
"styled-components",
118
"windows95",
12-
"component",
9+
"components",
1310
"vaporwave"
1411
],
1512
"license": "MIT",

0 commit comments

Comments
 (0)