diff --git a/README.md b/README.md index e0cfc7a..61ce164 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,15 @@ Build Status License - Releases - Read me docs + Releases + Read me docs Build Status Built with GoLang Platforms
Fast http sessions manager for Go.
-Simple API, while providing robust set of features such as immutability, expiration time (can be shifted), databases like boltdb, raw file, leveldb and redis as back-end storage.
+Simple API, while providing robust set of features such as immutability, expiration time (can be shifted), databases like boltdb, raw file, leveldb and redis as back-end storage.

@@ -40,6 +40,7 @@ sess. GetFlashes() map[string]interface{} VisitAll(cb func(k string, v interface{})) Set(string, interface{}) + SetImmutable(key string, value interface{}) SetFlash(string, interface{}) Delete(string) Clear() @@ -61,15 +62,27 @@ Features - Focus on simplicity and performance. - Flash messages. -- Supports any type of [external database](https://github.com/kataras/go-sessions/tree/master/_examples/3_redis_sessiondb). +- Supports any type of [external database](_examples/database). - Works with both [net/http](https://golang.org/pkg/net/http/) and [valyala/fasthttp](https://github.com/valyala/fasthttp). - -Docs +Documentation ------------ Take a look at the [./examples](https://github.com/kataras/go-sessions/tree/master/_examples) folder. +- [Overview](_examples/overview/main.go) +- [Standalone](_examples/standalone/main.go) +- [Fasthttp](_examples/fasthttp/main.go) +- [Secure Cookie](_examples/securecookie/main.go) +- [Flash Messages](_examples/flash-messages/main.go) +- [Databases](_examples/database) + * [File](_examples/database/file/main.go) + * [BoltDB](_examples/database/boltdb/main.go) + * [LevelDB](_examples/database/leveldb/main.go) + * [Redis](_examples/database/redis/main.go) + +Outline +------------ ```go // Start starts the session for the particular net/http request @@ -487,7 +500,7 @@ License can be found [here](LICENSE). [Travis]: http://travis-ci.org/kataras/go-sessions [License Widget]: https://img.shields.io/badge/license-MIT%20%20License%20-E91E63.svg?style=flat-square [License]: https://github.com/kataras/go-sessions/blob/master/LICENSE -[Release Widget]: https://img.shields.io/badge/release-v1.0.2-blue.svg?style=flat-square +[Release Widget]: https://img.shields.io/badge/release-v2.0.0-blue.svg?style=flat-square [Release]: https://github.com/kataras/go-sessions/releases [Chat Widget]: https://img.shields.io/badge/community-chat-00BCD4.svg?style=flat-square [Chat]: https://kataras.rocket.chat/channel/go-sessions