Update readme (#97)

This commit is contained in:
Victor Baranov 2018-02-06 00:18:30 +03:00 committed by Roman Storm
parent 20c60f3e0d
commit 2ecc6fd2dd
1 changed files with 6 additions and 29 deletions

View File

@ -6,42 +6,19 @@
## MetaMask plugin setup
* Connect to POA Network in MetaMask plugin (See [Connect to POA Network via MetaMask](https://github.com/poanetwork/wiki/blob/master/MetaMask-connect.md#connect-to-poa-network-via-metamask))
* Import your voting key to MetaMask Plugin (See [Governance section from wiki](https://github.com/poanetwork/wiki/blob/master/governance.md)).
## Governance Dapp lifecycle
Check [Governance Dapp section from wiki](https://github.com/poanetwork/wiki/blob/master/governance.md)
## Ballots page
You'll see the page with the list of all ballots. Here you can switch to see **ACTIVE** ballots.
**Search** by ballots' data is available too.
![](./docs/ballots.png)
* [Connect to POA Network in MetaMask plugin](https://github.com/poanetwork/wiki/wiki/POA-Network-on-MetaMask) and import your voting key.
## New ballot page
Click **NEW BALLOT** button from any page to create a new ballot.
## Governance Dapp overview
![](./docs/new_ballot.png)
Please check related posts in wiki [Governance Overview](https://github.com/poanetwork/wiki/wiki/Governance-Overview) and [Ballots life cycle](https://github.com/poanetwork/wiki/wiki/Ballots-Overview.-Life-cycle-and-limits)
## Configuration file
It is configured with [POA Network contract](https://github.com/poanetwork/poa-network-consensus-contracts)
## Configuration
Governance DApp is configured with [POA Network governance contracts](https://github.com/poanetwork/poa-network-consensus-contracts)
Path: `./src/contracts/addresses.js`
There are contracts' addresses for [sokol](https://github.com/poanetwork/poa-chain-spec/blob/sokol/contracts.json) and [core](https://github.com/poanetwork/poa-chain-spec/blob/core/contracts.json).
```
module.exports = {
VOTING_TO_CHANGE_KEYS_ADDRESS: '0x49df4ec19243263e5db22da5865b4f482b8323a0',
VOTING_TO_CHANGE_MIN_THRESHOLD: '0x8829ebe113535826e8af17ed51f83755f675789a',
VOTING_TO_CHANGE_PROXY: '0x6b728399b41a38d4109f7af2213d4cc31ca87812',
METADATA_ADDRESS: '0xcBB2912666c7e8023B7ec78B6842702eB26336aC',
POA_ADDRESS: '0x8bf38d4764929064f2d4d3a56520a76ab3df415b',
BALLOTS_STORAGE_ADDRESS: '0x0d7590c7aedf1e7e85fc9a1ee88f6f17d3ba762f'
}
```
## Building from source