zervo/vanity-eth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve README

Browse source
This commit is contained in:
Boris Kubiak 2018-02-09 15:29:12 +01:00
parent 1acaa6c64b
commit d679618d82
2 changed files with 38 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1,16 +1,46 @@
# Vanity ETH # Vanity-ETH
[![Build Status](https://travis-ci.org/bokub/vanity-eth.svg?branch=master)](https://travis-ci.org/bokub/vanity-eth) [![Build Status](https://travis-ci.org/bokub/vanity-eth.svg?branch=master)](https://travis-ci.org/bokub/vanity-eth)
[![Maintainability](https://api.codeclimate.com/v1/badges/818874f09ea56c310072/maintainability)](https://codeclimate.com/github/bokub/vanity-eth/maintainability) [![Maintainability](https://api.codeclimate.com/v1/badges/818874f09ea56c310072/maintainability)](https://codeclimate.com/github/bokub/vanity-eth/maintainability)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
Browser-based ETH vanity address generator Browser-based ETH vanity address generator
Just type [`git.io/veth`](https://git.io/veth) to use it ⚡️ Just type [`git.io/veth`](https://git.io/veth) to use it ⚡️
## Local usage
Check out the [wiki page](https://github.com/bokub/vanity-eth/wiki/Download-Vanity-ETH) ## Usage
First of all, visit [`git.io/veth`](https://git.io/veth)
Enter the prefix of your choice, then click 'generate' to start.
Ethereum addresses are hexadecimal, which means your prefix can only contain numbers and letters from A to F.
You can increase the number of threads allocated to address generation to be faster, or decrease it if you computer struggles.
## How it works
You browser is going to generate a ton of random addresses until one of them starts with your prefix.
Everything is computed by your browser, so you should notice a better speed on a powerful computer.
## Security
As explained above, everything is computed in your browser. Nothing ever leaves your machine, or even your browser tab.
You can download the latest build of Vantiy-ETH from Github and use it completely offline.
Vanity-ETH uses a cryptographically secure pseudorandom number generator (CSPRNG) to generate Ethereum addresses.
## Offline usage
Vanity-ETH works perfectly offline! Once the web page is loaded, you can turn off the internet and continue playing.
You can also download the latest build of Vanity-ETH, check out the [wiki page](https://github.com/bokub/vanity-eth/wiki/Download-Vanity-ETH)
## Local development ## Local development
@ -21,6 +51,7 @@ npm i
``` ```
Run the dev-sever while you code Run the dev-sever while you code
```sh ```sh
npm run dev npm run dev
``` ```

4
src/vue/Description.vue
View file

@ -23,7 +23,9 @@
<p> <p>
As explained above, everything is computed in your browser. Nothing ever leaves your machine, or As explained above, everything is computed in your browser. Nothing ever leaves your machine, or
even your browser tab.<br> even your browser tab.<br>
You can download the latest build of Vantiy-ETH from Vanity-ETH works perfectly offline! Once the web page is loaded, you can turn off the internet and continue
playing.<br>
You can also download the latest build of Vanity-ETH on
<a href="https://github.com/bokub/vanity-eth/wiki/download-Vanity-ETH">Github</a> and use it <a href="https://github.com/bokub/vanity-eth/wiki/download-Vanity-ETH">Github</a> and use it
completely offline.<br> completely offline.<br>
Vanity-ETH uses a cryptographically secure pseudorandom number generator (CSPRNG) to generate Vanity-ETH uses a cryptographically secure pseudorandom number generator (CSPRNG) to generate