Update readme file

[bytom/bytom-spv.git] / README.md

diff --git a/README.md b/README.md
index aacae0e..e153305 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,35 +1,23 @@
-Bytom
-=====
+Bytom SPV Wallet
+====
 
-[![AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-brightgreen.svg)](./LICENSE)
+[![Build Status](https://travis-ci.org/Bytom/bytom.svg)](https://travis-ci.org/Bytom/bytom) [![AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-brightgreen.svg)](./LICENSE)
 
-Table of Contents
-<!-- vim-markdown-toc GFM -->
+**Official golang implementation of the Bytom SPV Wallet.**
 
-* [What is Bytom?](#what-is-bytom)
-* [Build from source](#build-from-source)
-  * [Requirements](#requirements)
-  * [Installation](#installation)
-    * [Get the source code](#get-the-source-code)
-    * [Build](#build)
-* [Example](#example)
-  * [Create and launch a single node](#create-and-launch-a-single-node)
-  * [Issue an asset](#issue-an-asset)
-* [Contributing](#contributing)
-* [License](#license)
+Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://github.com/bytom-spv/bytom-spv/releases.
 
-<!-- vim-markdown-toc -->
+## What is Bytom SPV Wallet?
+SPV wallet verifies that a transaction is included in the  Bytom blockchain, without downloading the entire blockchain. The SPV wallet only needs to download the block headers, which are much smaller than the full blocks. To verify that a transaction is in a block, SPV wallet requests a proof of inclusion, in the form of a Merkle branch.
 
-## What is Bytom?
 
-Bytom is software designed to operate and connect to highly scalable blockchain networks confirming to the Bytom Blockchain Protocol. Each network allows partipicants to define, issue and transfer digitial assets on a multi-asset shared ledger.
+In the current state `bytom spv wallet` is able to:
 
-In the current state `bytom` is able to:
+- Manage key, account as well as asset
+- Send transactions, i.e., issue, spend and retire asset
 
-- Issue assets
-- Manage account as well as asset
 
-## Build from source
+## Building from source
 
 ### Requirements
 
@@ -44,60 +32,61 @@ $ go version
 $ go env GOROOT GOPATH
 ```
 
-#### Get the source code
+- Get the source code
 
 ``` bash
-$ git clone https://github.com/Bytom/bytom $GOPATH/src/github.com/bytom
+$ git clone https://github.com/bytom-spv/bytom-spv.git $GOPATH/src/github.com/bytom-spv
 ```
 
-#### Build
-
-- Bytom
+- Build source code
 
 ``` bash
-$ cd $GOPATH/src/github.com/bytom
-$ make install
-$ cd ./cmd/bytom
-$ go build
+$ cd $GOPATH/src/github.com/bytom-spv
+$ make bytom-spv    # build bytom-spv-wallet
 ```
 
-- Bytomcli
-
-```go
-$ cd $GOPATH/src/github.com/bytom/cmd/bytomcli
-$ go build
-```
+When successfully building the project, the `bytom-spv-wallet`  should be present in `cmd/bytomd` directory.
 
-## Example
+## Running bytom spv wallet
 
-### Create and launch a single node
+### Initialize
 
-When successfully building the project, the `bytom` and `bytomcli` binary should be present in `cmd/bytom/bytom` and `cmd/bytomcli/bytomcli`, respectively. Then, initialize the node:
+First of all, initialize the node:
 
 ```bash
-$ cd ./cmd/bytom
-$ ./bytom init --home ./.bytom
+$ cd ./cmd/bytomd
+$ ./bytom-spv-wallet init --chain_id testnet -r ~/.bytom_spv
 ```
 
-After that, you'll `.bytom` generated in current directory. Launch the single node:
+There are three options for the flag `--chain_id`:
+
+- `mainnet`: connect to the mainnet.
+- `testnet`: connect to the testnet wisdom.
+- `solonet`: standalone mode.
+
+After that, you'll see `config.toml` generated, then launch the node.
+
+### launch
 
 ``` bash
-$ ./bytom node --home ./.bytom
+$ ./bytom-spv-wallet node -r ~/.bytom_spv
 ```
 
-### Issue an asset
+### Dashboard
+
+Access the dashboard:
 
-```bash
-$ cd ./cmd/bytomcli
-$ ./bytomcli <command> <opt...>
+```
+$ open http://localhost:9888/
 ```
 
 ## Contributing
 
-Thank you for considering to help out with the source code! Any contributions are highly appreciated, and we are grateful for even the smallest of fixes!
+Thank you for considering helping out with the source code! Any contributions are highly appreciated, and we are grateful for even the smallest of fixes!
 
-If you run into an issue, feel free to [file one](https://github.com/Bytom/bytom/issues/) in this repository. We are glad to help!
+If you run into an issue, feel free to [bytom issues](https://github.com/bytom-spv/bytom/issues/) in this repository. We are glad to help!
 
 ## License
 
 [AGPL v3](./LICENSE)
+