OSDN Git Service

Change Readme for bytom spv wallet
authorYahtoo Ma <yahtoo.ma@gmail.com>
Thu, 30 Aug 2018 12:09:22 +0000 (20:09 +0800)
committerYahtoo Ma <yahtoo.ma@gmail.com>
Thu, 30 Aug 2018 12:09:22 +0000 (20:09 +0800)
README.md

index 90da80a..300a21a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,17 @@
-Bytom
+Bytom SPV Wallet
 ====
 
 [![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)
 
-**Official golang implementation of the Bytom protocol.**
+**Official golang implementation of the Bytom SPV Wallet.**
 
-Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://github.com/Bytom/bytom/releases.
+Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://github.com/Bytom/bytom-spv/releases.
 
-## What is Bytom?
+## What is Bytom SPV Wallet?
 
 Bytom is software designed to operate and connect to highly scalable blockchain networks confirming to the Bytom Blockchain Protocol, which allows partipicants to define, issue and transfer digitial assets on a multi-asset shared ledger. Please refer to the [White Paper](https://github.com/Bytom/wiki/blob/master/White-Paper/%E6%AF%94%E5%8E%9F%E9%93%BE%E6%8A%80%E6%9C%AF%E7%99%BD%E7%9A%AE%E4%B9%A6-%E8%8B%B1%E6%96%87%E7%89%88.md) for more details.
 
-In the current state `bytom` is able to:
+In the current state `bytom spv wallet` is able to:
 
 - Manage key, account as well as asset
 - Send transactions, i.e., issue, spend and retire asset
@@ -35,7 +35,7 @@ $ go env GOROOT GOPATH
 - Get the source code
 
 ``` bash
-$ git clone https://github.com/Bytom/bytom.git $GOPATH/src/github.com/bytom
+$ git clone https://github.com/Bytom/bytom-spv.git $GOPATH/src/github.com/bytom
 ```
 
 - Build source code
@@ -43,23 +43,13 @@ $ git clone https://github.com/Bytom/bytom.git $GOPATH/src/github.com/bytom
 ``` bash
 $ cd $GOPATH/src/github.com/bytom
 $ make bytomd    # build bytomd
-$ make bytomcli  # build bytomcli
 ```
 
-When successfully building the project, the `bytom` and `bytomcli` binary should be present in `cmd/bytomd` and `cmd/bytomcli` directory, respectively.
+When successfully building the project, the `bytomd`  should be present in `cmd/bytomd` directory.
 
-### Executables
+## Running bytom spv wallet
 
-The Bytom project comes with several executables found in the `cmd` directory.
-
-| Command      | Description                                                  |
-| ------------ | ------------------------------------------------------------ |
-| **bytomd**   | bytomd command can help to initialize and launch bytom domain by custom parameters. `bytomd --help` for command line options. |
-| **bytomcli** | Our main Bytom CLI client. It is the entry point into the Bytom network (main-, test- or private net), capable of running as a full node archive node (retaining all historical state). It can be used by other processes as a gateway into the Bytom network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `bytomcli --help` and the [bytomcli Wiki page](https://github.com/Bytom/bytom/wiki/Command-Line-Options) for command line options. |
-
-## Running bytom
-
-Currently, bytom is still in active development and a ton of work needs to be done, but we also provide the following content for these eager to do something with `bytom`. This section won't cover all the commands of `bytomd` and `bytomcli` at length, for more information, please the help of every command, e.g., `bytomcli help`.
+Currently, bytom is still in active development and a ton of work needs to be done, but we also provide the following content for these eager to do something with `bytom`. This section won't cover all the commands of `bytomd` at length, for more information, please the help of every command, e.g.
 
 ### Initialize