Move example code to README (#5)

The code exampleServer.go was added so that dep can correctly identify this repo as a Go repo. However, the file is not really used and the example code is better put into the README as a reference. This is replaced with a file named dep.go and a comment explaining the purpose of the file.
moexmen · Dec 8, 2017 · 94f8525 · 94f8525
1 parent 8c01089
commit 94f8525
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -9,4 +9,23 @@ Cryptographically random strings to be used for things like session IDs.
 ## Server
 Starts a HTTP server with graceful shutdown when receiving `SIGINT` or `SIGTERM`
 
+Example code:
+```
+import (
+	"log"
+	"time"
+
+	"github.com/moexmen/gokit/web"
+)
+
+func main() {
+	s := web.Server{
+		Addr:    ":8080",
+		Timeout: 5 * time.Second,
+	}
+	log.Println("Starting...")
+	log.Println(s.ListenAndServe())
+}
+```
+
 [Docker Stop](https://docs.docker.com/compose/reference/stop/) has a default timeout of 10 seconds. We recommend to use a timeout lower than 10 seconds if you use Docker.
diff --git a/dep.go b/dep.go
@@ -0,0 +1,2 @@
+// This file is used to ensure that dep correctly identifies this as a Go repository.
+package main
diff --git a/exampleServer.go b/exampleServer.go
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// This file is used to ensure that dep correctly identifies this as a Go repository.
		package main