OSDN Git Service

Revert "Recommit (#1547)" (#1583)
[bytom/bytom.git] / README.md
index 803b185..98107b3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,9 @@
 Bytom
-====
-Official golang implementation of the Bytom protocol.
-[![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)
+======
+
+[![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.**
 
 Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://github.com/Bytom/bytom/releases.
 
@@ -14,6 +16,11 @@ In the current state `bytom` is able to:
 - Manage key, account as well as asset
 - Send transactions, i.e., issue, spend and retire asset
 
+## Installing with Homebrew
+
+```
+brew tap bytom/bytom && brew install bytom
+```
 
 ## Building from source
 
@@ -46,20 +53,6 @@ $ 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.
 
-__simd feature:__
-
-You could enable the _simd_ feature to speed up the _PoW_ verification (e.g., during mining and block verification) by simply:
-```
-bytomd node --simd.enable
-```
-
-To enable this feature you will need to compile from the source code by yourself, and `make bytomd-simd`. 
-
-What is more,
-
-+ if you are using _Mac_, please make sure _llvm_ is installed by `brew install llvm`.
-+ if you are using _Windows_, please make sure _mingw-w64_ is installed and set up the _PATH_ environment variable accordingly.
-
 ### Executables
 
 The Bytom project comes with several executables found in the `cmd` directory.
@@ -115,6 +108,7 @@ available flags for `bytomd node`:
       --wallet.disable              Disable wallet
       --wallet.rescan               Rescan wallet
       --web.closed                  Lanch web browser or not
+      --simd.enable                 Enable the _simd_ feature to speed up the _PoW_ verification (e.g., during mining and block verification)
 ```
 
 Given the `bytomd` node is running, the general workflow is as follows:
@@ -123,6 +117,20 @@ Given the `bytomd` node is running, the general workflow is as follows:
 - send transaction, i.e., build, sign and submit transaction.
 - query all kinds of information, let's say, avaliable key, account, key, balances, transactions, etc.
 
+__simd feature:__
+
+You could enable the _simd_ feature to speed up the _PoW_ verification (e.g., during mining and block verification) by simply:
+```
+bytomd node --simd.enable
+```
+
+To enable this feature you will need to compile from the source code by yourself, and `make bytomd-simd`. 
+
+What is more,
+
++ if you are using _Mac_, please make sure _llvm_ is installed by `brew install llvm`.
++ if you are using _Windows_, please make sure _mingw-w64_ is installed and set up the _PATH_ environment variable accordingly.
+
 For more details about using `bytomcli` command please refer to [API Reference](https://github.com/Bytom/bytom/wiki/API-Reference)
 
 ### Dashboard