feat: improve CLI documentation, add Makefile for build automation, and update .gitignore

Author: devlopersabbir

.gitignore

@@ -13,3 +13,4 @@ bin/
 
 # Temporary CI release notes
 release_notes.md
+./bin/*

Makefile

@@ -0,0 +1,63 @@
+.PHONY: all build test clean gateway serve vet fmt check-deps help
+
+BINARY_DIR=bin
+CLI_BINARY=$(BINARY_DIR)/breez
+GATEWAY_BINARY=$(BINARY_DIR)/gateway
+
+# Default target
+all: build test
+
+## build: Build both CLI and Gateway binaries into ./bin
+build:
+	@mkdir -p $(BINARY_DIR)
+	@echo "Building Breez CLI..."
+	@go build -v -o $(CLI_BINARY) ./cmd/breez
+	@echo "Building Breez Gateway..."
+	@go build -v -o $(GATEWAY_BINARY) ./cmd/gateway
+	@echo "✔ Binaries successfully built in $(BINARY_DIR)/"
+
+## test: Run unit and integration test suite
+test:
+	@echo "Running tests..."
+	@go test -v -race ./...
+
+## vet: Run static analysis / go vet
+vet:
+	@echo "Running go vet..."
+	@go vet ./...
+
+## fmt: Format all Go source files
+fmt:
+	@echo "Formatting code..."
+	@gofmt -s -w .
+
+## check-deps: Tidy and verify go.mod dependencies
+check-deps:
+	@echo "Tidying go.mod..."
+	@go mod tidy
+	@go mod verify
+
+## gateway: Run Gateway server locally on port 8080
+gateway: build
+	@echo "Starting local Gateway server on :8080..."
+	@./$(GATEWAY_BINARY) --domain breez.localhost --port 8080
+
+## serve: Run CLI tunnel serving local port 3000 (Usage: make serve PORT=3000)
+PORT ?= 3000
+serve: build
+	@echo "Starting Breez CLI serving port $(PORT)..."
+	@./$(CLI_BINARY) serve $(PORT) --gateway http://localhost:8080
+
+## clean: Remove built binaries and temporary test files
+clean:
+	@echo "Cleaning binaries..."
+	@rm -rf $(BINARY_DIR)
+	@rm -f release_notes.md
+	@echo "✔ Clean completed."
+
+## help: Show list of available Makefile commands
+help:
+	@echo "Usage: make [target]"
+	@echo ""
+	@echo "Targets:"
+	@sed -n 's/^##//p' $(MAKEFILE_LIST) | column -t -s ':'

cmd/breez/main.go

@@ -18,32 +18,48 @@ var (
 func main() {
 	rootCmd := &cobra.Command{
 		Use:   "breez",
-		Short: "Breez - Instant local tunnel CLI",
-		Long:  "Expose your local development servers to the internet securely via Breez.",
+		Short: "Breez - Instant, lightweight local tunnel CLI",
+		Long: `☁  Breez CLI
+  Expose your local development HTTP servers to the public internet instantly.
+
+  Examples:
+    $ breez serve 3000
+    $ breez serve 8080 --subdomain myapp
+    $ breez serve 5173 --gateway https://gateway.breez.run`,
 	}
 
-	rootCmd.PersistentFlags().StringVar(&gatewayURL, "gateway", "http://localhost:8080", "Gateway server URL")
+	rootCmd.PersistentFlags().StringVarP(&gatewayURL, "gateway", "g", "http://localhost:8080", "Gateway server URL to connect with")
 
 	serveCmd := &cobra.Command{
 		Use:   "serve <port>",
-		Short: "Serve a local port over a public URL tunnel",
-		Args:  cobra.ExactArgs(1),
+		Short: "Create a public tunnel forwarding to your local HTTP server port",
+		Long: `Creates a secure WebSocket tunnel between your local port and the Breez Gateway server.
+
+Arguments:
+  <port>    The local port number where your application/server is running (e.g. 3000, 8080, 5173).
+
+Examples:
+  $ breez serve 3000
+  $ breez serve 8080 --subdomain custom-name
+  $ breez serve 5000 --gateway http://localhost:8080`,
+		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			port, err := strconv.Atoi(args[0])
 			if err != nil || port <= 0 || port > 65535 {
-				return fmt.Errorf("invalid port number: %s", args[0])
+				return fmt.Errorf("invalid port number: %s. Port must be an integer between 1 and 65535", args[0])
 			}
 
 			client := cli.NewClient(gatewayURL, port, subdomain)
 			return client.Serve()
 		},
 	}
 
-	serveCmd.Flags().StringVarP(&subdomain, "subdomain", "s", "", "Request a specific subdomain")
+	serveCmd.Flags().StringVarP(&subdomain, "subdomain", "s", "", "Request a custom subdomain name (e.g. --subdomain myapp)")
 
 	versionCmd := &cobra.Command{
 		Use:   "version",
-		Short: "Display CLI version information",
+		Short: "Display version, commit hash, and build timestamp",
+		Long:  "Displays the current installed Breez CLI version, git commit hash, and build timestamp.",
 		Run: func(cmd *cobra.Command, args []string) {
 			fmt.Printf("breez v%s (commit: %s, built at: %s)\n", version.Version, version.Commit, version.BuildDate)
 		},