aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkaotisk <kaotisk@arching-kaos.com>2021-03-15 01:18:45 +0200
committerkaotisk <kaotisk@arching-kaos.com>2021-03-15 01:18:45 +0200
commit5bb638ecf38308604fd1c8c8411fdcf22ebce334 (patch)
tree6dfa897970fa0f754e7ef588565140ca017308f9
parent6820a25d9c46c1bd8ffec5cf1a09c2be56f397f9 (diff)
downloadpython-cjdns-peering-tools-5bb638ecf38308604fd1c8c8411fdcf22ebce334.tar.gz
python-cjdns-peering-tools-5bb638ecf38308604fd1c8c8411fdcf22ebce334.tar.bz2
python-cjdns-peering-tools-5bb638ecf38308604fd1c8c8411fdcf22ebce334.zip
README.md update: usage
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index db90a96..8676931 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,15 @@
A small collection of tools for generating and importing peering information through python scripts.
+## Usage
+On your terminal, go!
+
+```
+git clone https://git.arching-kaos.net/kaotisk/python-cjdns-peering-tools.git
+cd python-cjdns-peering-tools
+sudo ./gen.sh
+```
+
## `appendPeers.py`
It's the script that gets a `cjdroute.conf` and `peers.json` to append IP4 peers to configuration file.