Skip to content

Commit d25f571

Browse files
Merge pull request #56 from React-Proto/refinedblessing-patch-1
Update README.md
2 parents e23190b + cdad1cd commit d25f571

File tree

1 file changed

+33
-15
lines changed

1 file changed

+33
-15
lines changed

README.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# React-Proto [![Build Status](https://travis-ci.com/CS-Eevee/react-proto.svg?branch=master)](https://travis-ci.com/CS-Eevee/react-proto) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
1+
# React-Proto [![Build Status](https://travis-ci.com/React-Proto/react-proto.svg?branch=master)](https://travis-ci.com/React-Proto/react-proto) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
22

33
<img src="https://github.com/React-Proto/react-proto/blob/master/icons/png/64x64.png"/>
44

5-
[React-Proto](https://react-proto.github.io/react-proto/) is a React application prototyping tool.
5+
[React-Proto](https://react-proto.github.io/react-proto/) is a React application prototyping tool for developers and designers.
66

7-
React-Proto allows developers to visualize/setup your application architecture upfront and recreate this architecture as application files either into a previous project or a new create-react-app project or a starter template from any repository.
7+
React-Proto allows the user to visualize/setup their application architecture upfront and eject this architecture as application files either into a previous project or a new create-react-app project or a starter template from any repository.
8+
9+
Download for [MacOS](https://github.com/React-Proto/react-proto/releases/download/v1.0.0/React-Proto-1.0.0.dmg), [Windows](https://github.com/React-Proto/react-proto/releases/download/v1.0.0/React-Proto.Web.Setup.1.0.0.exe), [Linux](https://github.com/React-Proto/react-proto/releases/download/v1.0.0/react-proto_1.0.0_amd64.deb).
810

9-
React-Proto works on macOS, & Windows
1011
If you find any issues, [file issue](https://github.com/React-Proto/react-proto/issues)
1112

1213
## How To Use
@@ -48,32 +49,49 @@ If you find any issues, [file issue](https://github.com/React-Proto/react-proto/
4849

4950
## Running Your Own Version
5051

51-
**Fork** and **Clone** Repository.
52+
- **Fork** and **Clone** Repository.
5253

54+
- Open project directory
5355

5456
``` bash
55-
# Open project directory
5657
cd react-proto
58+
```
59+
60+
- Install dependencies
5761

58-
# Install dependencies
62+
``` bash
5963
yarn install
64+
```
6065

61-
# Run application
66+
- Run application
67+
68+
``` bash
6269
yarn start
70+
```
6371

64-
# For development environment...
65-
yarn run dev
72+
- For development experience...
6673

67-
# on another terminal
68-
yarn run electron
74+
``` bash
75+
yarn dev
76+
```
77+
78+
- and on another terminal
79+
80+
``` bash
81+
yarn electron
82+
```
83+
84+
## Linting
6985

70-
# Run Linter
71-
yarn run linter
86+
``` bash
87+
yarn linter
7288
```
7389

7490
## Testing
7591

76-
Run ```npm test``` or ```yarn test``` to run test suite.
92+
```bash
93+
yarn test
94+
```
7795

7896
## Built With
7997

0 commit comments

Comments
 (0)