Readme update

Signed-off-by: Prabhu Subramanian <[email protected]>
AppThreat · Jan 14, 2024 · 2e95890 · 2e95890
1 parent a9cc60c
commit 2e95890
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# Introduction
+
+This project is a fork of the [overflowdb](https://github.com/ShiftLeftSecurity/overflowdb) project with the following modifications:
+
+- There is no overflowing so this is just an API-compatible DB!
+- Removed use of slf4j, MDC contexts, and updated to Java 21 release
+
+## Why?
+
+For large projects, we observed that the Heap Monitor used by the upstream project was too taxing. By removing such complexity and letting modern JVM and OS deal with swapping we noticed significant performance improvements (2-3x)
+
+## License
+
+Apache-2.0
diff --git a/build.sbt b/build.sbt
@@ -1,6 +1,6 @@
 name := "overflowdb2"
 ThisBuild / organization := "io.appthreat"
-ThisBuild / version      := "0.0.3"
+ThisBuild / version      := "1.0.0"
 ThisBuild / scalaVersion := "3.3.1"
 publish / skip := true