Create README.md

This commit is contained in:
ChronosX88 2019-04-10 18:46:53 +04:00 committed by GitHub
parent 24c668bd4e
commit 8e3c749efe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# Influence Bootstrap Node
This is the main node of the network messenger Influence.
## 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.md](https://github.com/ChronosX88/Influence-Bootstrap-Node/blob/master/LICENSE) file for details