README.md in zold-0.9.9 vs README.md in zold-0.9.10
- old
+ new
@@ -1,17 +1,17 @@
-<img src="http://www.zold.io/logo.svg" width="64px" height="64px"/>
+<img src="http://www.zold.io/logo.svg" width="92px" height="92px"/>
[](http://www.elegantobjects.org)
[](https://www.0crat.com/p/C91QJT4CF)
[](http://www.rultor.com/p/yegor256/Zold)
[](https://www.jetbrains.com/ruby/)
-[](https://travis-ci.org/zerocracy/zold)
+[](https://travis-ci.org/yegor256/zold)
[](https://ci.appveyor.com/project/yegor256/zold)
[](http://www.0pdd.com/p?name=yegor256/zold)
[](http://badge.fury.io/rb/zold)
-[](https://codecov.io/github/zerocracy/zold?branch=master)
+[](https://codecov.io/github/yegor256/zold?branch=master)
[](https://gemnasium.com/yegor256/zold)
[](https://codeclimate.com/github/yegor256/zold/maintainability)
**NOTICE**: It's an experiment and a very early draft! Please, feel free to
@@ -21,39 +21,43 @@
The license is [MIT](https://github.com/yegor256/zold/blob/master/LICENSE.txt).
## How to Use
-Install Ruby 2.2+, [Rubygems](https://rubygems.org/pages/download), and then run:
+First, install [Ruby 2.3+](https://www.ruby-lang.org/en/documentation/installation/),
+[Rubygems](https://rubygems.org/pages/download), and
+the [gem](https://rubygems.org/gems/zold):
```bash
$ sudo apt-get install ruby-dev rubygems zlib1g-dev
$ gem install zold
```
-For more options and commands you can always use this:
+To make sure it's installed, try:
```bash
$ zold --help
```
-You will need PGP keys in `~/.ssh`. To generate them (if you don't have them yet):
+You will need PGP private and public keys in `~/.ssh`.
+If you don't have them yet, run this in order to generate a new pair
+(just hit <kbd>Enter</kbd> when it asks you for a password):
```bash
$ ssh-keygen -t rsa -b 4096
```
-First, create a wallet (instead of `5f96e731e48ae21f` there will be your
-person wallet number, use it everywhere below):
+Then, create a new wallet (instead of `5f96e731e48ae21f` there will be your
+personal wallet ID, use it everywhere below):
```bash
$ zold create
5f96e731e48ae21f
```
-Then, give its number to your friend, who is going to pay you.
-When the payment is sent, ask him or her for the number of the wallet
+Then, give this ID to your friend, who is going to pay you.
+When the payment is sent, ask him or her for the ID of the wallet
the payment has been sent from and then fetch that wallet
(let's say it is `5555444433332222`):
```bash
$ zold fetch 5555444433332222
@@ -77,22 +81,33 @@
```
That's it.
You also can contribute to Zold by running a node on your server.
-In order to do that just run:
+In order to do that just run (with your own wallet ID, of course,
+and your own public IP address instead of `4.4.4.4`):
```bash
-$ zold node --invoice=5f96e731e48ae21f
+$ zold node --trace --verbose --invoice=5f96e731e48ae21f --host=4.4.4.4
```
+Then, open the page `4.4.4.4:4096` in your browser.
+If you see a simple JSON document, everything is fine.
+Next, hit <kbd>Ctrl</kbd>+<kbd>c</kbd> and run this line, in order
+to start the node and make sure it will be online even when you log off
+(replace `CMD` with the command you just executed before):
+
+```bash
+$ nohup bash -c 'while CMD; do gem install zold; done' &
+```
+
Grateful users of the system will pay "taxes" to your wallet
for the maintenance of their wallets.
## How to Contribute
It is a Ruby command line gem. First, install
-[Ruby](https://www.ruby-lang.org/en/documentation/installation/) 2.3+,
+[Ruby 2.3+](https://www.ruby-lang.org/en/documentation/installation/),
[Rubygems](https://rubygems.org/pages/download),
and
[Bundler](https://bundler.io/).
Then: