diff --git a/README.md b/README.md index 29144ec..568274d 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,149 @@ -# PyBlock v0.2.0 +# PyBlock v0.3.0 Bitcoin Blockchain information program A simple Python Block Clock to check the Blockchain information. -## Dependences +- This will fully work on a node that has Bitcoin Core and LND installed +- We fully tested and worked perfect on [MyNodeBTC](https://mynodebtc.com/) - a@A:~> pip3 install -r requirements.txt +## First Start + +- You will need to find the path of the files tls.cert and admin.macaroon to do the REST connection to have access to LND. + + ### From local node - - Install the [Hexyl](https://github.com/sharkdp/hexyl) + Open the Terminal + + - Type these commands: + + * a@A:~> git clone https://github.com/curly60e/pyblock.git + * a@A:~> cd pyblock + * a@A:~> pip3 install -r requirements.txt + * a@A:~> python3 PyBlock.py + +
+ + - This is how we continue. + +
+ + + +
+ + - It will ask you for the IP:PORT (REST PORT) in this case use: localhost instead of the IP. + +
+ + + +
+ + - Then it will ask you for the path to the tls.cert. + +
+ + + +
+ + - Then it will ask you for the path to the admin.macaroon. + +
+ + + +
+ + - Then it will ask you for the path to bitcoin-cli or if you have already installed just put: bitcoin-cli. + +
+ + + +
+ + - And you are in. + +
+ + + +
+ + ### From remote computer with Bitcoin Core installed + + * You will need to have tls.cert and admin.macaroon already downloaded from your LND node. + + - Open the Terminal. + + - Type these commands: + + * a@A:~> git clone https://github.com/curly60e/pyblock.git + * a@A:~> cd pyblock + * a@A:~> pip3 install -r requirements.txt + * a@A:~> python3 PyBlock.py + +
+ + - This is how we continue. + +
+ + + +
+ + - It will ask you for the IP:PORT (REST PORT). + +
+ + + +
+ + - Then it will ask you for the path to the tls.cert. + +
+ + + +
+ + - Then it will ask you for the path to the admin.macaroon. + +
+ + + +
+ + - Then it will ask you for the path to bitcoin-cli or if you have already installed just put: bitcoin-cli. + +
+ + + +
+ + - And you are in. + +
+ + + +
+ + +## Dependencies + + - Install [Hexyl](https://github.com/sharkdp/hexyl) ## How to execute + - python3 PyBlock.py ## Connect to an external node first steps