Skip to content

Commit 46910db

Browse files
authored
Merge pull request #52 from React-Proto/read_me
edits to how to
2 parents 37988e6 + f525918 commit 46910db

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
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/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)
22

3-
[React-Proto](https://cs-eevee.github.io/react-proto/) is a React application prototyping tool.
3+
<img src="https://github.com/React-Proto/react-proto/blob/master/icons/png/64x64.png"/>
4+
5+
[React-Proto](https://react-proto.github.io/react-proto/) is a React application prototyping tool.
46

57
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.
68

79
React-Proto works on macOS, & Windows
8-
If you find any issues, [file issue](https://github.com/CS-Eevee/react-proto/issues)
10+
If you find any issues, [file issue](https://github.com/React-Proto/react-proto/issues)
911

1012
## How To Use
1113

12-
- To start a new project, either import an image file for the application you want to build or start with a blank stage.
14+
- To start a new project, either import a mockup or start with a blank stage.
1315

14-
- Using the input at the top of the left column, input the name of the component you would like to create, then drag it into place and resize accordingly.
16+
- Add components you would like to create using the input, then drag the component frame into place and resize accordingly.
1517

16-
<img src="https://github.com/CS-Eevee/react-proto/blob/master/assets/dragging.gif"/>
18+
<img src="https://github.com/React-Proto/react-proto/blob/master/assets/dragging.gif"/>
1719

18-
- While building, you can use the icons in the toolbar to zomm in and zoom out, toggle the draggability of the stage, update or remove the image, collapse the left container, and eventually export your files.
20+
- While building, you can use the icons in the toolbar to zoom, toggle draggability of the stage, update or remove an image, collapse the left container, and export your files.
1921

20-
- For each component you have a series of options: You can define whether your component will have state, the color of the component on the screen, and the ability to apply a parent component.
22+
- For each component you have the ability to define whether your component will have state, the color of the frame component, and the ability to apply a parent component.
2123

22-
- If you place a container around other components and can no longer access them, you can use the layer buttons in the corresponding dropdown menu to decrease the z-index. Alternatively, you can increase the z-index of the desired components.
24+
- If you place a container around other components and can no longer access them, you can use the layer buttons in the corresponding dropdown menu to change layer order down or up.
2325

24-
- After you have successfully structured your components, you can use the dropdown menu to apply parent components and visualize the hierarchy of your application structure.
25-
26-
<img src="https://github.com/CS-Eevee/react-proto/blob/master/assets/hierarchy.gif"/>
26+
<img src="https://github.com/React-Proto/react-proto/blob/master/assets/hierarchy.gif"/>
2727

2828
- In the right container, the props tab allows you to define props in key value pairs, as well as the necessary prop type.
2929

@@ -32,7 +32,7 @@ If you find any issues, [file issue](https://github.com/CS-Eevee/react-proto/iss
3232
2. Use create-react-app to start a new project (the project will be under the "proto_app").
3333
3. Clone your favorite Github repo to start a project with your favorite starter files.
3434

35-
<img src="https://github.com/CS-Eevee/react-proto/blob/master/assets/export.gif"/>
35+
<img src="https://github.com/React-Proto/react-proto/blob/master/assets/export.gif"/>
3636

3737

3838
- Lastly, start building!
@@ -86,4 +86,4 @@ Run ```npm test``` or ```yarn test``` to run test suite.
8686

8787
## License
8888

89-
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/CS-Eevee/react-proto/blob/master/LICENSE.md) file for details.
89+
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/React-Proto/react-proto/blob/master/LICENSE.md) file for details.

0 commit comments

Comments
 (0)