diff --git a/README.md b/README.md index 4af923f..ad16fd9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,73 @@ -# JGUN -Implementation of [GUN](https://gun.eco/) database in Java -`// Useful README coming soon... ` +

+

JGUN

+

+ This is a distributed database for Java, port of GUN (which originally written in JavaScript). +

+

+ + +
+ +## Table of Contents + +- [Intro](#intro) +- [Building](#building) +- [Features](#features) +- [Useful links](#useful-links) +- [License](#license) +- [Author](#author) + +## Intro +A realtime, decentralized, offline-first, mutable graph protocol to sync the Internet. + +### Requirements +* JRE/JDK >= 1.8.0 + +## Building +1. Clone repo: +```bash +$ git clone https://github.com/ChronosX88/JGUN +$ cd JGUN +``` +2. Compile it: +```bash +./gradlew shadowJar +``` +3. Compiled JAR located in `./build/libs/` + +(Also exists precompiled JARs - see Releases (publishing to Maven coming soon...)) + +[⇧ back to top](#contents) + +## Features +- Put to database +- Get from database +- Track changes in database + +[⇧ back to top](#contents) + +## Useful links + +- [GUN](https://gun.eco) +- [GUN GitHub](https://github.com/amark/gun) +- [GUN Docs (how GUN works)](https://gun.eco/docs) + +[⇧ back to top](#contents) + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +[⇧ back to top](#contents) + +## Author + +```txt +Author : ChronosX88 +Email : chronosx88@gmail.com +Github : https://github.com/ChronosX88/JGUN.git +``` + +[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com) + +[⇧ back to top](#contents)