Updated README.md

Signed-off-by: Vishal Rana <vr@labstack.com>
2026-06-20 01:18:42 +02:00 · 2016-03-10 22:40:21 -08:00
parent 91e5f755ad
commit 300d57894d
2 changed files with 76 additions and 67 deletions
@@ -1,8 +1,7 @@
 # *NOTICE*
 - Master branch, website and godoc now points to Echo v2.
- It is advisable to migrate to v2. (https://labstack.com/echo/migrating)
+- It is advisable to migrate to v2. (https://labstack.com/echo/guide/migrating)
 - Looking for v1?
 	- Installation: Use a package manager (https://github.com/Masterminds/glide, it's nice!) to get stable v1 release/commit or use `go get gopkg.in/labstack/echo.v1`.
 	- Godoc: https://godoc.org/gopkg.in/labstack/echo.v1
@@ -12,89 +11,95 @@
 **A fast and unfancy micro web framework for Go.**
-```go
+## Features
 package main
-import (
+- Fast HTTP router which smartly prioritize routes.
-	"github.com/labstack/echo"
+- Run with standard HTTP server or FastHTTP server.
-	// "github.com/labstack/echo/engine/fasthttp"
+- Extensible middleware framework.
-	"github.com/labstack/echo/engine/standard"
+- Router groups with nesting.
-	"github.com/labstack/echo/middleware"
+- Handy functions to send variety of HTTP responses.
-)
+- Centralized HTTP error handling.
-
+- Template rendering with any template engine.
 func main() {
 	e := echo.New()
 	e.Use(middleware.Logger())
 	e.Use(middleware.Recover())
 	e.Get("/", echo.HandlerFunc(func(c echo.Context) error {
 		return c.String(200, "Hello, World!")
 	}))
 	e.Get("/v2", echo.HandlerFunc(func(c echo.Context) error {
 		return c.String(200, "Echo v2")
 	}))
 	// FastHTTP
 	// e.Run(fasthttp.New(":1323"))
 	// Standard
 	e.Run(standard.New(":1323"))
 }
 ```
 ## Performance
 Based on [vishr/go-http-routing-benchmark] (https://github.com/vishr/go-http-routing-benchmark), June 5, 2015.
 ##### [GitHub API](http://developer.github.com/v3)
 > Echo: 38662 ns/op, 0 B/op, 0 allocs/op
 ![Performance](http://i.imgur.com/hB2qdRS.png)
 ## Getting Started
 ### Installation
 ```sh
 $ go get github.com/labstack/echo
 ```
-BenchmarkAce_GithubAll              20000             93675 ns/op           13792 B/op      167 allocs/op
+
-BenchmarkBear_GithubAll             10000            264194 ns/op           79952 B/op      943 allocs/op
+### Hello, World!
-BenchmarkBeego_GithubAll             2000           1109160 ns/op          146272 B/op      2092 allocs/op
+
-BenchmarkBone_GithubAll              1000           2063973 ns/op          648016 B/op     8119 allocs/op
+Create `main.go`
-BenchmarkDenco_GithubAll            20000             83114 ns/op           20224 B/op       167 allocs/op
+
-BenchmarkEcho_GithubAll             30000             38662 ns/op               0 B/op        0 allocs/op
+```go
-BenchmarkGin_GithubAll              30000             43467 ns/op               0 B/op        0 allocs/op
+package main
-BenchmarkGocraftWeb_GithubAll        5000            386829 ns/op          133280 B/op      1889 allocs/op
+
-BenchmarkGoji_GithubAll              3000            561131 ns/op           56113 B/op      334 allocs/op
+import (
-BenchmarkGoJsonRest_GithubAll        3000            490789 ns/op          135995 B/op      2940 allocs/op
+	"net/http"
-BenchmarkGoRestful_GithubAll          100          15569513 ns/op          797239 B/op      7725 allocs/op
+
-BenchmarkGorillaMux_GithubAll         200           7431130 ns/op          153137 B/op      1791 allocs/op
+	"github.com/labstack/echo"
-BenchmarkHttpRouter_GithubAll       30000             51192 ns/op           13792 B/op       167 allocs/op
+	"github.com/labstack/echo/engine/standard"
-BenchmarkHttpTreeMux_GithubAll      10000            138164 ns/op           56112 B/op       334 allocs/op
+	"github.com/labstack/echo/middleware"
-BenchmarkKocha_GithubAll            10000            139625 ns/op           23304 B/op       843 allocs/op
+)
-BenchmarkMacaron_GithubAll           2000            709932 ns/op          224960 B/op      2315 allocs/op
+
-BenchmarkMartini_GithubAll            100          10261331 ns/op          237953 B/op      2686 allocs/op
+// Handler
-BenchmarkPat_GithubAll                500           3989686 ns/op         1504104 B/op    32222 allocs/op
+func hello() echo.HandlerFunc {
-BenchmarkPossum_GithubAll            5000            259165 ns/op           97441 B/op       812 allocs/op
+	return func(c echo.Context) error {
-BenchmarkR2router_GithubAll         10000            240345 ns/op           77328 B/op      1182 allocs/op
+		return c.String(http.StatusOK, "Hello, World!\n")
-BenchmarkRevel_GithubAll             2000           1203336 ns/op          345554 B/op      5918 allocs/op
+	}
-BenchmarkRivet_GithubAll            10000            247213 ns/op           84272 B/op      1079 allocs/op
+}
-BenchmarkTango_GithubAll             5000            379960 ns/op           87081 B/op      2470 allocs/op
+
-BenchmarkTigerTonic_GithubAll        2000            931401 ns/op          241089 B/op      6052 allocs/op
+func main() {
-BenchmarkTraffic_GithubAll            200           7292170 ns/op         2664770 B/op     22390 allocs/op
+	// Echo instance
-BenchmarkVulcan_GithubAll            5000            271682 ns/op           19894 B/op       609 allocs/op
+	e := echo.New()
-BenchmarkZeus_GithubAll              2000            748827 ns/op          300688 B/op     2648 allocs/op
+
 	// Middleware
 	e.Use(middleware.Logger())
 	e.Use(middleware.Recover())
 	// Routes
 	e.Get("/", hello())
 	// Start server
 	e.Run(standard.New(":1323"))
 }
 ```
 Start server
 ```sh
 $ go run main.go
 ```
 Browse to [http://localhost:1323](http://localhost:1323) and you should see
 Hello, World! on the page.
 ### Next?
 - Browse [recipes](/recipes/hello-world)
 - Head over to [guide](/guide/installation")
 ## Contribute
 **Use issues for everything**
- Report problems
+- Report issues
- Discuss before sending a pull request
+- Discuss before sending pull request
- Suggest new features/recipes
+- Suggest new features
 - Improve/fix documentation
 ## Support
 - [Chat](https://gitter.im/labstack/echo)
 ## Credits
 - [Vishal Rana](https://github.com/vishr) - Author
 - [Nitin Rana](https://github.com/nr17) - Consultant
 - [Contributors](https://github.com/labstack/echo/graphs/contributors)
 ## License
 [MIT](https://github.com/labstack/echo/blob/master/LICENSE)
@@ -11,3 +11,7 @@
        </nav>
    </div>
 </header>
 <div style="padding: 4px; text-align: center; background: #ff851b; color: #fff;">
    This is Echo v2 website. If you are looking for v1 docs, they can be found <a style=
 "color: #fff;" href="https://github.com/labstack/echo/tree/v1/website/content"><b>here</b>.</a>
 </div>