diff --git a/DozerDB_logo.png b/DozerDB_logo.png new file mode 100644 index 0000000..50fdf35 Binary files /dev/null and b/DozerDB_logo.png differ diff --git a/README.md b/README.md index ce8e3f3..1cbda03 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,72 @@ -# README +

+ DozerDB +

+

+ Plugin build for DozerDB — combines core and browser into a single deployable artifact +

-## About -DozerDb enhances Neo4j core / AKA Neo4j Community Edition with enterprise features. +

+ License + Java 17+ + Neo4j +

-This project builds the actual plugin which is used to enhance Neo4j Community Edition. +

+ Get Started + Contact Us +

-See https://dozerdb.org for installation instructions. +--- -## Versioning -The plugin combines the dozerdb-core and dozerdb-browser artifacts into an uber jar which is dropped into the Neo4j lib directory and takes control of the bootstrap process. +## 📋 About -The version uses the current Neo4j full version number and appends the final number anytime the dozerdb-core or dozerdb-browser projects have an update. +DozerDB enhances Neo4j Community Edition with enterprise features. This project builds the plugin — an uber JAR that combines [dozerdb-core](https://github.com/dozerdb/dozerdb-core) and [dozerdb-browser](https://github.com/dozerdb/dozerdb-browser) into a single artifact. -Example - for Neo4j version 5.26.22 - the first release would be 5.26.22.0. -If a change occurs within the dozerdb-browser or dozerdb-core package - then the version would become: 5.26.22.1 and so on. +The plugin JAR is dropped into the Neo4j `lib` directory and takes control of the bootstrap process. -## Development -Please ensure you use java 17 or above when working on the plugin. +Visit **[dozerdb.org](https://dozerdb.org)** for installation instructions. -If you would like to use an open source java version manager - please check out https://sdkman.io/ -For those using sdkman - you can use the following command to switch to the favor of openjdk that we use. +--- +## 🔢 Versioning +The plugin version uses the current Neo4j full version number and appends a release number for DozerDB updates: -## Building -Ensure you have JDK 17+ first or you will get compile errors. +| Neo4j Version | DozerDB Release | Plugin Version | +|---------------|-----------------|----------------| +| 5.16.0 | First release | `5.16.0.0` | +| 5.16.0 | Browser update | `5.16.0.1` | +| 5.16.0 | Core fix | `5.16.0.2` | -To build the project - you can run the following command: -``` -./mvnw clean verify +The final number increments whenever `dozerdb-core` or `dozerdb-browser` has an update. + +--- + +## 🛠️ Development + +### Prerequisites + +- **Java 17+** is required. You will get compile errors with older versions. +- We recommend [SDKMAN!](https://sdkman.io/) as an open source Java version manager. + +### Building + +```bash +./mvnw clean verify ``` + +--- + +## 📞 Support + +

+ Email Us + More Info +

+ +--- + +

+ © 2026 DozerDB Contributors +