diff --git a/README.md b/README.md index 770e9a1..0fef7d2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,25 @@ # MiNode Python 3 implementation of the Bitmessage protocol. Designed only to route objects inside the network. + +## Requirements +- python3 (or pypy3) +- openssl + ## Running -Make sure you have Python 3.x installed. ``` git clone https://github.com/TheKysek/MiNode.git ``` ``` cd MiNode -``` -``` chmod +x start.sh ./start.sh ``` + +It is worth noting that while executing the `start.sh` file MiNode tries to do a `git pull` in order to update itself to the latest version. + +## Contact +- TheKysek: BM-2cVUMXVnQXmTJDmb7q1HUyEqkT92qjwGvJ + +## Links +- [Bitmessage project website](https://bitmessage.org) +- [Ptotocol specification](https://bitmessage.org/wiki/Protocol_specification)