From 012b8a3c7100956afaf98daeee679ce6dc6f3ad7 Mon Sep 17 00:00:00 2001 From: Gerasimos Maropoulos Date: Mon, 25 Jul 2016 20:28:44 +0300 Subject: [PATCH] A risk to update the first-view of the README --- README.md | 88 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 45 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index c07d4580..e6f28e64 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,41 @@ -[![Iris Logo](https://github.com/iris-contrib/logo/raw/contribs/OneebMalik/Iris%20Logo%20with%20bg_README.jpg)](https://github.com/iris-contrib/logo/tree/contribs/OneebMalik) +

- [![Travis Widget]][Travis] [![Report Widget]][Report] [![License Widget]][License] [![Release Widget]][Release] [![Documentation Widget]][Documentation] [![Chat Widget]][Chat] [![Examples Widget]][Examples] -The [fastest](#benchmarks) web framework for Go. Easy to use, while it's highly customizable. + + +
+Build Status + +License + +Releases + +Practical Guide/Docs +
+Examples + +Build Status + +Built with GoLang + +Platforms +

+ + +The fastest backend web framework, written entirely in Go.
+Ideally suited for both experienced and novice Developers.
+ Easy to learn, while it's highly customizable. + + + +

+ +----- + - -```go -package main -import "github.com/kataras/iris" -func main() { - iris.Get("/hi_json", func(c *iris.Context) { - c.JSON(iris.StatusOK, iris.Map{ - "Name": "Iris", - "Born": "13 March 2016", - "Stars": 4453, - }) - }) - iris.Listen(":8080") -} -``` Installation ------------ @@ -40,45 +54,33 @@ Docs & Community - - Read [the guide](https://www.gitbook.com/book/kataras/iris/details), if you wish you can [donate](DONATIONS.md) also. + - The most important is to read [the practical guide](https://www.gitbook.com/book/kataras/iris/details). - - Take a look at the mini [examples](https://github.com/iris-contrib/examples) + - Explore & download the [examples](https://github.com/iris-contrib/examples). - [HISTORY.md](https://github.com//kataras/iris/tree/master/HISTORY.md) file is your best friend. - If you'd like to discuss this package, or ask questions about it, feel free to +If you'd like to discuss this package, or ask questions about it, feel free to - * Post an issue or idea [here](https://github.com/kataras/iris/issues) - * [Chat][Chat] + * Post an issue or idea [here](https://github.com/kataras/iris/issues). + * [Chat][Chat]. -The new Iris [logo](https://github.com/iris-contrib/logo) is designed by [Corey Worrell](https://github.com/coreyworrell) - -Open debates +Iris takes very seriously your opinion, - [Contribute: New website and logo for Iris](https://github.com/kataras/iris/issues/153) -- [E-book Cover - Which one you suggest?](https://github.com/kataras/iris/issues/67) - - Features ------------ - Focus on high performance -- Robust routing supports static and wildcard subdomains +- Robust routing, static, wildcard subdomains and routes. +- Websocket API, Sessions support out of the box - View system supporting [6+](https://kataras.gitbooks.io/iris/content/template-engines.html) template engines -- Add custom [responses](https://github.com/iris-contrib/examples/tree/master/response_engines/my_custom_response/main.go) or customize & replace the [defaults](https://github.com/iris-contrib/response/) -- Highly scalable Websocket API with custom events -- Sessions support with GC, memory & redis providers -- Middlewares & Plugins were never be easier -- Full REST API -- Custom HTTP Errors -- Typescript compiler + Browser-based editor -- Content negotiation & streaming -- Transport Layer Security -- [Reload](https://github.com/kataras/iris/tree/master/iris#run) on source code changes -- OAuth, OAuth2 supporting 27+ API providers -- JSON Web Tokens -- and more +- Highly scalable response engines +- Live reload +- Typescript integration + Online editor +- OAuth, OAuth2 supporting 27+ API providers, JWT, BasicAuth +- and many other surprises