0.1.0

Author: DavidCai1111

README.md

@@ -1,3 +1,38 @@
 # mux
 [![Build Status](https://travis-ci.org/go-http-utils/mux.svg?branch=master)](https://travis-ci.org/go-http-utils/mux)
 [![Coverage Status](https://coveralls.io/repos/github/go-http-utils/mux/badge.svg?branch=master)](https://coveralls.io/github/go-http-utils/mux?branch=master)
+
+HTTP mux for Go.
+
+## Installation
+
+```
+go get -u github.com/go-http-utils/mux
+```
+
+## Documentation
+
+API documentation can be found here: https://godoc.org/github.com/go-http-utils/mux
+
+## Usage
+
+```go
+import (
+  "github.com/go-http-utils/mux"
+)
+```
+
+```go
+m := mux.New()
+
+m.Get("/:type(a|b)/:id", mux.HandlerFunc(func(res http.ResponseWriter, req *http.Request, params map[string]string) {
+  res.WriteHeader(http.StatusOK)
+
+  fmt.Println(params["type"])
+  fmt.Println(params[":id"])
+
+  res.Write([]byte("Hello Worlkd"))
+}))
+
+http.ListenAndServe(":8080", m)
+```

mux.go

@@ -9,9 +9,9 @@ import (
 )
 
 // Version is this package's version number.
-const Version = "0.0.2"
+const Version = "0.1.0"
 
-// Handler responds to a HTTP request.
+// Handler likes the http.Handler but with the URL named params support.
 type Handler interface {
 	ServeHTTP(http.ResponseWriter, *http.Request, map[string]string)
 }