Skip to content

Commit 3bf70bd

Browse files
committed
Update README to follow the standard
1 parent ab056b1 commit 3bf70bd

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# vDexNode-GUI application
2+
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
3+
> vDexNode graphic interface
4+
25
The application allows you to manage a vDexNode node running in a openDHT network using a set of smart contracts of the EOS blockchain platform.
36

47
<img width="1426" alt="Screen_Shot_2019-09-18_at_12_42_16_PM" src="https://user-images.githubusercontent.com/2269864/65180517-e9018180-da11-11e9-8967-87fd55666b07.png">
58

9+
## Table of Contents
10+
11+
- [Prerequisites](#prerequisites)
12+
- [Install](#install)
13+
- [Usage](#usage)
14+
- [Contributing](#contributing)
15+
- [License](#license)
616

717
## Prerequisites
818
For the application to work, it is **recommended** to use the **YARN** package manager, however, with the **NPM**, the application will also work.
@@ -99,4 +109,17 @@ yarn run build-linux # build for linux electron platform
99109
yarn run publish # build for current user electron platform and upload the binaries as a release on GitHub
100110
yarn run publish-all # Build for all electron platforms and upload the binaries as a release on github
101111
yarn run publish-linux # build for linux electron platform and upload the binary as a release on github
102-
```
112+
```
113+
## Contributing
114+
115+
See [the contributing file](CONTRIBUTING.md)!
116+
117+
PRs accepted.
118+
119+
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
120+
121+
### Any optional sections
122+
123+
## License
124+
125+
[MIT © Volentix Labs.](../LICENSE)

src/pages/Index.vue

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,6 @@
153153
</q-scroll-area>
154154
</div>
155155
<div class="col-xs-12 col-sm-12 col-md-3 col-lg-3">
156-
<!-- <div class="text-italic text-vgrey">Voting for the nodes.</div>
157-
<div class="text-italic text-vgrey text-caption">*Activates when you select at least one node to vote</div> -->
158156
<q-banner inline-actions class="bg-vdark text-vgrey q-mb-sm">
159157
<div class="text-italic q-py-md">Voting.</div>
160158
<template v-slot:action>

0 commit comments

Comments
 (0)