diff --git a/README.md b/README.md index 5094ed8b..e5cf645b 100644 --- a/README.md +++ b/README.md @@ -232,6 +232,19 @@ From here we can build: ```cargo build``` +## grovedbg + +There is a work in progress implementation of a debugger layer for GroveDB. To use this library with +these capabilities enabled one needs to set a dependency with `grovedbg` feature. Then, to launch +visualizer tool to observe the database structure inside of your browser on a port, let's say 10000, +the following snippet should do: + +```rust + let db = Arc::new(GroveDb::open("db").unwrap()); + db.start_visualzier(10000); +``` + +Just remember to use Arc because the HTTP server might outlast the GroveDB instance. ## Performance