diff --git a/readme.md b/readme.md index aa9a01e..09a036a 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,23 @@ ### Godb A SQLite like database made in golang + +Inorder to run this locally, after cloning this repo run `go mod tidy` + +Then use the appropriate `make` command listed below + +Run + +```make run``` + +Build + +```make build``` + +Start + +```make start``` + +Cleanup + +```make clean```