From 7f381c7e584e10abc613c89a6496515a0848d8e9 Mon Sep 17 00:00:00 2001
From: Max Claus Nunes <maxcnunes@gmail.com>
Date: Sat, 18 Dec 2021 07:28:48 -0300
Subject: [PATCH] Add example for custom configurations

---
 CONTRIBUTING.md         |  2 +-
 README.md               | 10 ++++++++++
 testdata/server/main.go |  4 +++-
 3 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0cb02ae..e8c5eda 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -28,7 +28,7 @@ make setup
 ### Running gaper in development
 
 ```
-make build && ./gaper --verbose --bin-name srv --build-path ./testdata/server
+make build && ./gaper --verbose --bin-name srv --build-path ./testdata/server --build-args="-ldflags=\"-X 'main.Version=v1.0.0'\""
 ```
 
 ### Running lint
diff --git a/README.md b/README.md
index fcad128..402eab6 100644
--- a/README.md
+++ b/README.md
@@ -98,6 +98,16 @@ Using all defaults provided by Gaper:
 gaper
 ```
 
+Example providing a few custom configurations:
+
+```
+gaper \
+	--bin-name build/api-dev \
+	--build-path cmd/server \
+	--build-args "-ldflags=\"-X 'main.Version=dev'" \
+	--watch .
+```
+
 Ignore watch over all test files:
 
 > no need for this if you have not disabled the default ignore settings `--disable-default-ignore`
diff --git a/testdata/server/main.go b/testdata/server/main.go
index 1c4e359..71d1be9 100644
--- a/testdata/server/main.go
+++ b/testdata/server/main.go
@@ -7,6 +7,8 @@ import (
 	"net/http"
 )
 
+var Version string
+
 func main() {
 	http.HandleFunc("/foo", func(w http.ResponseWriter, r *http.Request) {
 		fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path)) // nolint gas
@@ -16,6 +18,6 @@ func main() {
 		log.Fatal("Forced failure")
 	})
 
-	log.Println("Starting server")
+	log.Println("Starting server: Version", Version)
 	log.Fatal(http.ListenAndServe(":8080", nil))
 }