Update README.md

README.md

@@ -1,3 +1,73 @@
-# JGUN
+<p align="center">
-Implementation of [GUN](https://gun.eco/) database in Java  
+	<h1 align="center">JGUN</h1>
-`// Useful README coming soon... `
+	<p align="center">
+  This is a distributed database for Java, port of <a href="https://gun.eco">GUN</a> (which originally written in JavaScript).
+  </p>
+ </p>
+
+<!-- Used for the "back to top" links within the document -->
+<div id="contents"></div>
+
+## 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...))
+
+<sub>[⇧ back to top](#contents)</sub>
+
+## Features
+- Put to database
+- Get from database
+- Track changes in database
+
+<sub>[⇧ back to top](#contents)</sub>
+
+## Useful links
+
+- [GUN](https://gun.eco)
+- [GUN GitHub](https://github.com/amark/gun)
+- [GUN Docs (how GUN works)](https://gun.eco/docs)
+
+<sub>[⇧ back to top](#contents)</sub>
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+<sub>[⇧ back to top](#contents)</sub>
+
+## 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)
+
+<sub>[⇧ back to top](#contents)</sub>