Skip to content

Commit

Permalink
Add some more content how to use
Browse files Browse the repository at this point in the history
  • Loading branch information
miohtama committed Nov 30, 2018
1 parent 1452079 commit 901e2b8
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 7 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -6,6 +6,9 @@ __pycache__/
# C extensions
*.so

# OSX
.DS_Store

# Distribution / packaging
.Python
env/
Expand Down
29 changes: 22 additions & 7 deletions README.rst
Expand Up @@ -70,12 +70,24 @@ Then within the activated venv do::
How to set up
=============

Below are short instructions how to set up an Ethereum node, account and configuration file for a testnet (no real money involved) to test out tokens.
Below are short instructions how to set up an Ethereum node, account and configuration file for the Kovan testnet (no real money involved).

Set up Parity
-------------
You need an Ethereum node. You can either install yourself (see Install Parity) or use a Ethereum node provider like `Infura <https://infura.io/>`_.

First install geth or Parity. For example on OSX::
Sign up for Infura (Option a)
-----------------------------

`Sign up for Infura <https://infura.io/>`_.

Get a **Kovan** node URL from your dashboard (use dropdown):

.. image:: https://github.com/TokenMarketNet/sto/raw/master/docs/source/screenshots/infura.png
:width: 500 px

Install Parity (Option b)
-------------------------

First `install Parity. For example on OSX::

brew install parity

Expand Down Expand Up @@ -108,14 +120,12 @@ Now create a file `myconfig.ini` and add the content::
# "kovan" or "ethereum"
network = kovan

# Where to connect for Parity or Geth JSON-RPC API
# This is for Parity - if you are using Infura get your Kovan node URL from your Infura dashboard
ethereum-node-url = http://localhost:8545

# The private key for your generated Ethereum account
ethereum-private-key = 3fac35a57e1e2867290ae37d54c5de61d52644b42819ce6af0c5a9c25f4c....

Visit `Kovan faucet <https://faucet.kovan.network/>`_ and request some Kovan ETH (KETH) on your account you just created.

Test that your account has balance and Parity node works::

sto --config-file=myconfig.ini diagnose
Expand All @@ -130,6 +140,11 @@ This should output::
All systems ready to fire


Top it up
---------

Visit `Kovan faucet <https://faucet.kovan.network/>`_ and request some Kovan ETH (KETH) on your account you just created. A `Github account <http://github.com/>`_ is needed for verification.

Playing with security tokens
============================

Expand Down
Binary file added docs/screenshots/infura.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 901e2b8

Please sign in to comment.