diff --git a/README.md b/README.md index 50e7db6ebb52ce7beb7002e42866508baa302305..90687ae938cd24628bb089466a629045cd4d40fc 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,92 @@ -# Fether +# Parity Fether - a fast and decentralized wallet based on a light-client ## Get the latest binary -https://github.com/paritytech/fether/releases +[» Download the latest release «](https://github.com/paritytech/fether/releases) -## Getting started + +### Join the chat! + +Get in touch with us on Gitter: +[![Gitter](https://img.shields.io/badge/Gitter-Fether-brightgreen.svg)](https://gitter.im/paritytech/fether) + + +Official website: https://parity.io | Be sure to check out [our Wiki](https://wiki.parity.io) for more information. + +---- + +## About Parity Fether + +Fether aims to be the lightest and simplest decentralized wallet. It supports Ether and ERC-20 tokens and runs on top of [Parity Ethereum](https://github.com/paritytech/parity) light client allowing smooth synchronization and interaction with the Ethereum blockchain, in a decentralized manner. + +By default, Parity Fether alpha runs on the Kovan test network. You can receive free Kovan Ether by posting your address in the [Kovan Faucet](https://gitter.im/kovan-testnet/faucet) Gitter channel. Fether will download and launch Parity Ethereum node at startup if it's not found on the computer. You can also separately launch your Ethereum client, Fether will automatically connect to it. + +If you run into problems while using Parity Fether, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](https://github.com/paritytech/parity/blob/master/SECURITY.md). + +Parity Fether connects to the light node using light.js, a Javascript library specifically crafted for Wallets to connect with light clients. It is licensed under the BSD 3-Clause, and can be used for all your Ethereum needs. + +---- + +## Start Parity Fether + +### Manually + +To start Parity Fether manually, just run: ```bash -git clone https://github.com/paritytech/fether -yarn install +$ fether ``` +Fether will launch a Partity Ethereum light node and print its output in the command line. +### Passing Parity Ethereum flags + +You can pass specific flags for fether to launch the underlying Parity Ethereum with: +```bash +# Launch Parity Ethereum light client on Ropsten and connect Fether to it +$ fether --chain ropsten --light +``` +### Separately launch Parity Ethereum node + +You can launch Parity Ethereum before Fether: +```bash +$ parity --chain ropsten --light +``` +In another console launch Fether: +```bash +# Fether will connect to the running node +$ fether +``` + +## Build from sources + + +### Dependencies Make sure you have at least `yarn` version 1.4.2 ```bash yarn --version // Should be at least 1.4.2 ``` +### Clone this repo + +```bash +git clone https://github.com/paritytech/fether +cd ./fether +yarn install +``` -## Build this repo and run +### Build this repo and run ```bash yarn electron ``` -## Build binaries +### Build binaries ```bash yarn package ``` -## Run with live reload for development +### Run with live reload for development ```bash yarn start