From ecc44c89983b9945d11d7b1787e4df8de74f6e7b Mon Sep 17 00:00:00 2001 From: F483 Date: Mon, 25 Jan 2016 18:09:42 -0500 Subject: [PATCH] updated readme --- README.rst | 72 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 45 insertions(+), 27 deletions(-) diff --git a/README.rst b/README.rst index 2c2ce0a..ef55337 100644 --- a/README.rst +++ b/README.rst @@ -85,7 +85,7 @@ Usage Farming ======= -Start a farmer on the local machine. +Starting a farmer on the local machine. The wallet is used for node authentication and payment if no cold storage address is provided in the config. @@ -113,7 +113,8 @@ Configuration ############# All configuration taken from the config file, stored in the following -locations by default. If it does not exist a default config file will be +locations by default. +If it does not exist a default config file will be created with conservative settings. :: @@ -139,7 +140,7 @@ Using the json-rpc service ########################## The storj protocol interface is be made available to other applications via a -[standard json-rpc service](http://www.jsonrpc.org/specification). +`standard json-rpc service `_. The rpc interface matches the cli interface exactly. @@ -199,15 +200,15 @@ Basic commands Get node information -------------------- -+---------------+-----------------------+ -| Description | Get node information | -+---------------+-----------------------+ -| Command | info | -+---------------+-----------------------+ -| Arguments | | -+---------------+-----------------------+ -| returns | json | -+---------------+-----------------------+ ++---------------+-----------------------------------------------------------+ +| Command | info | ++---------------+-----------------------------------------------------------+ +| Arguments | | ++---------------+-----------------------------------------------------------+ +| Returns | json | ++---------------+-----------------------------------------------------------+ +| Raises | | ++---------------+-----------------------------------------------------------+ .. code:: python @@ -221,13 +222,17 @@ Get node information Farm ---- -+---------------+-----------------------+ -| Command | farm | -+---------------+-----------------------+ -| Arguments | rpc=False | -+---------------+-----------------------+ -| returns | | -+---------------+-----------------------+ ++---------------+-----------------------------------------------------------+ +| Command | farm | ++---------------+-----------------------------------------------------------+ +| Arguments | rpc=False (bool): TODO help text | +| | hostname="localhost" (string): TODO help text | +| | port=8080 (integer): TODO help text | ++---------------+-----------------------------------------------------------+ +| Returns | | ++---------------+-----------------------------------------------------------+ +| Raises | | ++---------------+-----------------------------------------------------------+ .. code:: python @@ -248,7 +253,9 @@ Get the current config. +---------------+-----------------------------------------------------------+ | Arguments | | +---------------+-----------------------------------------------------------+ -| returns | json | +| Returns | json | ++---------------+-----------------------------------------------------------+ +| Raises | | +---------------+-----------------------------------------------------------+ .. code:: python @@ -268,7 +275,9 @@ Get the default config. +---------------+-----------------------------------------------------------+ | Arguments | | +---------------+-----------------------------------------------------------+ -| returns | json | +| Returns | json | ++---------------+-----------------------------------------------------------+ +| Raises | | +---------------+-----------------------------------------------------------+ .. code:: python @@ -288,7 +297,9 @@ Get the jsonschema for config validation. +---------------+-----------------------------------------------------------+ | Arguments | | +---------------+-----------------------------------------------------------+ -| returns | json | +| Returns | json | ++---------------+-----------------------------------------------------------+ +| Raises | | +---------------+-----------------------------------------------------------+ .. code:: python @@ -309,9 +320,12 @@ Insert a key/value pair into the DHT. +---------------+-----------------------------------------------------------+ | Command | dht_put | +---------------+-----------------------------------------------------------+ -| Arguments | key, value | +| Arguments | key (json): TODO help text | +| | value (json): TODO help text | ++---------------+-----------------------------------------------------------+ +| Returns | bool | +---------------+-----------------------------------------------------------+ -| returns | bool | +| Raises | | +---------------+-----------------------------------------------------------+ .. code:: python @@ -329,9 +343,11 @@ Get value from the DHT for a given key. +---------------+-----------------------------------------------------------+ | Command | dht_get | +---------------+-----------------------------------------------------------+ -| Arguments | key | +| Arguments | key (json): TODO help text | +---------------+-----------------------------------------------------------+ -| returns | json | +| Returns | json | ++---------------+-----------------------------------------------------------+ +| Raises | | +---------------+-----------------------------------------------------------+ .. code:: python @@ -351,7 +367,9 @@ Dump the contents of the nodes DHT storage. +---------------+-----------------------------------------------------------+ | Arguments | | +---------------+-----------------------------------------------------------+ -| returns | json | +| Returns | json | ++---------------+-----------------------------------------------------------+ +| Raises | | +---------------+-----------------------------------------------------------+ .. code:: python