From ad3eb9009396ac015250d59f5d0fefd352994b65 Mon Sep 17 00:00:00 2001
From: Vinit Parekh <vinitparekh1742@gmail.com>
Date: Fri, 22 Nov 2024 12:58:02 +0530
Subject: [PATCH] updates makefile and readme (#1310)

---
 Makefile  | 20 ++++++++++++--------
 README.md | 15 +--------------
 2 files changed, 13 insertions(+), 22 deletions(-)

diff --git a/Makefile b/Makefile
index 3a1409051..41432e024 100644
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,5 @@
+# Adapted from https://www.thapaliya.com/en/writings/well-documented-makefiles/
+
 THREADS ?= 4 #number of threads
 CLIENTS ?= 50 #number of clients per thread
 REQUESTS ?= 10000 #number of requests per client
@@ -43,13 +45,6 @@ unittest: ## run the unit tests
 unittest-one: ## run a single unit test function by name (e.g. make unittest-one TEST_FUNC=TestSetGet)
 	go test -v -race -count=1 --run $(TEST_FUNC) ./internal/...
 
-release: ## build and push the Docker image to Docker Hub with the latest tag and the version tag
-	git tag $(VERSION)
-	git push origin --tags
-	docker build --tag dicedb/dicedb:latest --tag dicedb/dicedb:$(VERSION) .
-	docker push dicedb/dicedb:$(VERSION)
-	docker push dicedb/dicedb:latest
-
 ##@ Benchmarking
 
 run_benchmark: ## run the memtier benchmark with the specified parameters
@@ -96,4 +91,13 @@ check-golangci-lint:
 clean: ## clean the dicedb binary
 	@echo "Cleaning build artifacts..."
 	rm -f dicedb
-	@echo "Clean complete."
\ No newline at end of file
+	@echo "Clean complete."
+
+##@ Deployment
+
+release: ## build and push the Docker image to Docker Hub with the latest tag and the version tag
+	git tag $(VERSION)
+	git push origin --tags
+	docker build --tag dicedb/dicedb:latest --tag dicedb/dicedb:$(VERSION) .
+	docker push dicedb/dicedb:$(VERSION)
+	docker push dicedb/dicedb:latest
diff --git a/README.md b/README.md
index 20cc1aa98..8bc5f956a 100644
--- a/README.md
+++ b/README.md
@@ -105,19 +105,6 @@ By default, DiceDB will look for the configuration file at `./dicedb.conf`. (Lin
 
 > [!TIP]
 > If you want to use a custom configuration file, you can specify the path using the `-c` flag. and to output the configuration file to a specific location, you can specify the output dir path using the `-o` flag.
-#### Additional Configuration Options:
-
-If you'd like to use a different location, you can specify a custom configuration file path with the `-c flag`:
-
-```bash
-go run main.go -c /path/to/config.toml
-```
-If you'd like to output the configuration file to a specific location, you can specify a custom output path with the `-o flag`:
-
-```bash
-go run main.go -o /path/of/output/dir
-```
-
 
 ### Setting up CLI
 
@@ -222,4 +209,4 @@ Contributors can join the [Discord Server](https://discord.gg/6r8uXWtXh7) for qu
 ```
 $ sudo netstat -atlpn | grep :7379
 $ sudo kill -9 <process_id>
-```
\ No newline at end of file
+```