From ab1cc5abfa6b36daff9fc32ddc0b9e6b536526a5 Mon Sep 17 00:00:00 2001 From: Djuri Baars Date: Sun, 3 Oct 2021 02:37:20 +0200 Subject: [PATCH] Updated readme with faster flow, no more asking/searching for channel IDs! --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7c2d196..77b344e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Ringtools Ringtools is a tool to keep an eye on the by you provided channels, like to monitor a Ring of Fire. + + -------------------- ## Installation @@ -9,6 +11,8 @@ Ringtools is a tool to keep an eye on the by you provided channels, like to moni 3. Clone this repository `git clone https://github.com/StijnBTC/Ringtools` 4. Navigate to the right folder `cd Ringtools` 5. Install the requirements `pip3 install -r requirements.txt` -6. Edit the channel file `sudo nano channels.txt` -7. Replace all channels with the channels from your ring and save (Ctrl+X following Y (Yes)) -8. Run Ringtools `python3 ringtools.py -f -l status` (When you're ready, hit Ctrl+C) + +## Usage +1. Put all public keys and telegram usernames, separated with a comma in `pubkeys.txt` +2. Run `checkring` functionality with write to create channels.txt `python3 ringtools.py check --write-channels` +3. Run Ringtools `python3 ringtools.py -f -l status` (When you're ready, hit Ctrl+C)