Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@F483
F483 committed Jan 25, 2016
1 parent e6cf782 commit ecc44c8
Showing 1 changed file with 45 additions and 27 deletions.
72 changes: 45 additions & 27 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

::
Expand All @@ -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 <http://www.jsonrpc.org/specification>`_.

The rpc interface matches the cli interface exactly.

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -248,7 +253,9 @@ Get the current config.
+---------------+-----------------------------------------------------------+
| Arguments | |
+---------------+-----------------------------------------------------------+
| returns | json |
| Returns | json |
+---------------+-----------------------------------------------------------+
| Raises | |
+---------------+-----------------------------------------------------------+

.. code:: python
Expand All @@ -268,7 +275,9 @@ Get the default config.
+---------------+-----------------------------------------------------------+
| Arguments | |
+---------------+-----------------------------------------------------------+
| returns | json |
| Returns | json |
+---------------+-----------------------------------------------------------+
| Raises | |
+---------------+-----------------------------------------------------------+

.. code:: python
Expand All @@ -288,7 +297,9 @@ Get the jsonschema for config validation.
+---------------+-----------------------------------------------------------+
| Arguments | |
+---------------+-----------------------------------------------------------+
| returns | json |
| Returns | json |
+---------------+-----------------------------------------------------------+
| Raises | |
+---------------+-----------------------------------------------------------+

.. code:: python
Expand All @@ -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
Expand All @@ -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
Expand All @@ -351,7 +367,9 @@ Dump the contents of the nodes DHT storage.
+---------------+-----------------------------------------------------------+
| Arguments | |
+---------------+-----------------------------------------------------------+
| returns | json |
| Returns | json |
+---------------+-----------------------------------------------------------+
| Raises | |
+---------------+-----------------------------------------------------------+

.. code:: python
Expand Down

0 comments on commit ecc44c8

Please sign in to comment.