More descriptive README

This commit is contained in:
l-n-s
2017-08-06 15:59:54 -04:00
parent 8af40230a4
commit bbfa3cc3c6

View File

@ -4,8 +4,8 @@ docker testnet
Run and manage your own local I2P network with docker.
Usage
-----
Install
-------
Install requirements and add your user to docker group ([security notes](https://docs.docker.com/engine/installation/linux/linux-postinstall/)):
@ -25,12 +25,41 @@ Create virtual environment and install:
python3 -m venv venv && source venv/bin/activate
pip install .
Usage
-----
Run with `testnet` command:
testnet
Play with it:
Read help message:
testnet> help
Start a network, this command creates 1 floodfill node and a reseed server:
testnet> start
Add 5 floodfill nodes and 10 regular nodes:
testnet> add 5 ff
testnet> add 10
Show network statistics overview:
testnet> stats
Show individual node information:
testnet> inspect d34db33f1001
Remove couple of nodes:
testnet> inspect d34db33f1001 3f1001d34db3
Stop a network and quit:
testnet> stop
testnet> quit