ringtools/ringtools-cli
1
0
Fork 0
mirror of https://github.com/StijnBTC/Ringtools.git synced 2025-02-28 07:54:09 +01:00
Code Issues Projects Releases Wiki Activity

Updated readme with faster flow, no more asking/searching for channel IDs!

Browse source
This commit is contained in:
Djuri Baars 2021-10-03 02:37:20 +02:00
parent e32a460835
commit ab1cc5abfa
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,6 +1,8 @@
# Ringtools # Ringtools
Ringtools is a tool to keep an eye on the by you provided channels, like to monitor a Ring of Fire. Ringtools is a tool to keep an eye on the by you provided channels, like to monitor a Ring of Fire.
-------------------- --------------------
## Installation ## 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` 3. Clone this repository `git clone https://github.com/StijnBTC/Ringtools`
4. Navigate to the right folder `cd Ringtools` 4. Navigate to the right folder `cd Ringtools`
5. Install the requirements `pip3 install -r requirements.txt` 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)) ## Usage
8. Run Ringtools `python3 ringtools.py -f -l status` (When you're ready, hit Ctrl+C) 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)