aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkaotisk <kaotisk@arching-kaos.com>2021-03-15 01:26:44 +0200
committerkaotisk <kaotisk@arching-kaos.com>2021-03-15 01:26:44 +0200
commit386676e77abecf6b4f837ab2651980c263000482 (patch)
tree35241362089782c1d44e096c0b6bbe1919c0eb78
parent5bb638ecf38308604fd1c8c8411fdcf22ebce334 (diff)
downloadpython-cjdns-peering-tools-386676e77abecf6b4f837ab2651980c263000482.tar.gz
python-cjdns-peering-tools-386676e77abecf6b4f837ab2651980c263000482.tar.bz2
python-cjdns-peering-tools-386676e77abecf6b4f837ab2651980c263000482.zip
Clear up things
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 8676931..3310758 100644
--- a/README.md
+++ b/README.md
@@ -10,22 +10,23 @@ git clone https://git.arching-kaos.net/kaotisk/python-cjdns-peering-tools.git
cd python-cjdns-peering-tools
sudo ./gen.sh
```
+## Files
-## `appendPeers.py`
+### `appendPeers.py`
It's the script that gets a `cjdroute.conf` and `peers.json` to append IP4 peers to configuration file.
-## `gen.sh`
+### `gen.sh`
Different ways to generate a `cjdroute.conf` with no comments so we can work with it as JSON in Python.
-## `peer_info_generate.py`
+### `peer_info_generate.py`
Script that creates a user and a password in `authorizedPasswords` and generates `peer_info_generated.json` file.
-## `peer_info_generated.json`
+### `peer_info_generated.json`
This is a generated file by `peer_info_generate.py` which contains the peering information for someone to connect to your node.
You should manually change `0.0.0.0` to your public IP4. #TODO Script for that
-## `peers.json`
-File with peering information.
+### `peers.json`
+File with peering information. Inside there are two working servers from [Arching Kaos Project](https://arching-kaos.net).
You can use https://github.com/hyperboria/peers to generate `peers.json`