From 27f44d3d5bf5da41c1b5f40dbb4a8ab1abdbad95 Mon Sep 17 00:00:00 2001 From: Ryan Grothouse Date: Wed, 25 May 2016 22:45:34 -0400 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index b0e6c41..d5e1c86 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,28 @@ ### Packages - [Gin](https://github.com/gin-gonic/gin) - HTTP Web Framework - [Glide](https://github.com/Masterminds/glide) - Vendor package management / version pinning + +### Running +#### Clone +`git clone https://github.com/udryan10/go-api-boilerplate.git` +#### Install dependencies +`glide install` +#### Running +`go run main.go` +#### Testing API +``` +$ curl http://localhost:8080/status -v +* Trying ::1... +* Connected to localhost (::1) port 8080 (#0) +> GET /status HTTP/1.1 +> Host: localhost:8080 +> User-Agent: curl/7.43.0 +> Accept: */* +> +< HTTP/1.1 200 OK +< Content-Type: application/json; charset=utf-8 +< Date: Thu, 26 May 2016 02:45:13 GMT +< Content-Length: 3 +< +{} +* Connection #0 to host localhost left intact```