From 3e719ea69eada3574aa391e20f7325228128188d Mon Sep 17 00:00:00 2001 From: ChronosX88 Date: Fri, 12 Apr 2019 15:27:15 +0400 Subject: [PATCH] Create README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..debb906 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Influence Bootstrap Node + +This is the main node of the Influence messenger network. +## Installation + +1. Clone this repo +2. Compile JAR: + +```bash +$ cd Influence-Bootstrap-Node +$ ./gradlew shadowJar +``` +3. Compiled JAR located in `./build/libs/` +(Also there are already compiled versions, see [releases](https://github.com/ChronosX88/Influence-Bootstrap-Node/releases)) +## Usage +1. Run the node: +```bash +$ java -jar influence-bootstrap-node.jar +``` +Now your bootstrap node is running and available on `*ip*:7243`! + +## Contributing +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +Please make sure to update tests as appropriate. + +## License +This project is licensed under the GNU GPLv3 License - see the [LICENSE](https://github.com/ChronosX88/Influence-Bootstrap-Node/blob/master/LICENSE) file for details