mirror of
https://github.com/ChronosX88/Influence-Bootstrap-Node.git
synced 2024-11-08 17:31:00 +00:00
Create README.md
This commit is contained in:
parent
e81039c010
commit
3e719ea69e
28
README.md
Normal file
28
README.md
Normal file
@ -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
|
Loading…
Reference in New Issue
Block a user