Skip to content

Commit f559cc0

Browse files
committed
toc updated, back to top added
1 parent 3a7c96d commit f559cc0

File tree

1 file changed

+24
-11
lines changed

1 file changed

+24
-11
lines changed

README.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<h1 align="center">
22
<img src="https://raw.githubusercontent.com/jeisele2/OverVue/master/src/assets/overvue-icons/apple-icon-72x72.png">
33
<br/>
4-
OverVue (Beta)
4+
OverVue
55
</h1>
66

77
<p align="center"><b>Prototyping Tool for Vue Developers</b></p>
@@ -15,14 +15,14 @@
1515
## Table of Contents
1616

1717
* [Features](#features)
18-
* [Changelog](#changelog)
19-
* [Tutorial](#howtouse)
20-
+ [New Features Tutorial](#overvue-v2.0-how-to)
18+
* [OverVue 2.0 Changelog](#changelog)
19+
* [Tutorial](#how-to-use)
20+
+ [New Features Tutorial](#overvue-v20-how-to)
2121
* [How to Run](#running-a-local-version)
2222
* [Contributing](#contributing)
2323
* [Authors](#authors)
2424

25-
#### Features
25+
### Features
2626
+ Upload a frontend mockup image
2727
+ Visualize draggable and resizable components
2828
+ Create parent-child hierarchy of components
@@ -40,7 +40,9 @@
4040
+ Will now load route images along with project <sub><sup>(v2.0)</sup></sub>
4141
+ Windows compatibility for uploading mockup images. <sub><sup>(v2.0)</sup></sub>
4242

43-
#### Changelog
43+
[↥Back to top](#table-of-contents)
44+
45+
### Changelog
4446
<details><summary>OverVue 2.0</summary>
4547
<ul>
4648
<li>Improved hierarchy tree rendering</li>
@@ -57,7 +59,9 @@
5759
</ul>
5860
</details>
5961

60-
#### How to use
62+
[↥Back to top](#table-of-contents)
63+
64+
## How to use
6165
+ Opening the application will create by default a root App component and a root route called "HomeView"
6266
+ Upload a mockup from your filesystem if you'd like. Remove the mockup and choose a new one if needed.
6367
![](https://raw.githubusercontent.com/jeisele2/OverVue/master/src/assets/gifs/upload-image-drawers.gif)
@@ -99,7 +103,9 @@ src/
99103
babel.config.js
100104
package.json
101105
```
102-
###### OverVue v2.0 How to
106+
[↥Back to top](#table-of-contents)
107+
108+
### OverVue v2.0 How to
103109
+ Undo/Redo feature has been added to the top right of the program, you can also use CTRL+z and CTRL+y respectively.
104110

105111
+ You can nest html elements in two different ways:
@@ -114,7 +120,9 @@ package.json
114120
+ Setting layers on a component is done by right clicking the desired component on the component display and using the menu option
115121
All components start on layer 1 by default.
116122

117-
#### Running a local version
123+
[↥Back to top](#table-of-contents)
124+
125+
### Running a local version
118126
This app was developed using the Quasar framework, so first you will need to install the Quasar cli
119127
```
120128
npm i -g @quasar/cli
@@ -132,7 +140,9 @@ To build a new .dmg / windows .exe
132140
quasar build -m electron
133141
```
134142

135-
#### Contributing
143+
[↥Back to top](#table-of-contents)
144+
145+
### Contributing
136146
We'd love for you to test this application out and submit any issues you encounter. Also feel free to fork to your own repo and submit PRs.
137147
Here are some features we're thinking about adding:
138148
+ Vuex state prototyping and boilerplate export
@@ -141,7 +151,9 @@ Here are some features we're thinking about adding:
141151
+ Integration with Storybook
142152
+ Ability to add a copy of an existing component from one route to another
143153

144-
#### Authors
154+
[↥Back to top](#table-of-contents)
155+
156+
### Authors
145157
```
146158
Contributors:
147159
Joseph Eisele @jeisele2
@@ -154,3 +166,4 @@ Allison Pratt @allisons11
154166
Joju Olaode @JojuOlaode
155167
```
156168
Inspired by [PreVue](https://github.com/open-source-labs/PreVue)
169+
[↥Back to top](#table-of-contents)

0 commit comments

Comments
 (0)