Skip to content

Commit 4590780

Browse files
committed
update readme
1 parent 56f48cc commit 4590780

File tree

5 files changed

+81
-27
lines changed

5 files changed

+81
-27
lines changed

README.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -280,21 +280,42 @@ Examples:
280280

281281
### Redirect
282282

283+
redirect to other page
284+
283285
```go
284-
r.GET("/", func(c *rux.Context) {
285-
c.AbortThen().Redirect("/login", 302)
286-
})
287-
288-
// Or
289-
r.GET("/", func(c *rux.Context) {
290-
c.Redirect("/login", 302)
291-
c.Abort()
292-
})
286+
r.GET("/", func(c *rux.Context) {
287+
c.AbortThen().Redirect("/login", 302)
288+
})
293289

294-
r.GET("/", func(c *rux.Context) {
295-
c.Back()
296-
c.Abort()
297-
})
290+
// Or
291+
r.GET("/", func(c *rux.Context) {
292+
c.Redirect("/login", 302)
293+
c.Abort()
294+
})
295+
296+
r.GET("/", func(c *rux.Context) {
297+
c.Back()
298+
c.Abort()
299+
})
300+
```
301+
302+
### Cookies
303+
304+
you can quick operate cookies by `FastSetCookie()` `DelCookie()`
305+
306+
> Note: You must set or delete cookies before writing BODY content
307+
308+
```go
309+
r.GET("/setcookie", func(c *rux.Context) {
310+
c.FastSetCookie("rux_cookie2", "test-value2", 3600)
311+
c.SetCookie("rux_cookie", "test-value1", 3600, "/", c.Req.URL.Host, false, true)
312+
c.WriteString("hello, in " + c.URL().Path)
313+
})
314+
315+
r.GET("/delcookie", func(c *rux.Context) {
316+
val := ctx.Cookie("rux_cookie") // "test-value1"
317+
c.DelCookie("rux_cookie", "rux_cookie2")
318+
})
298319
```
299320

300321
### Multi Domains

README.zh-CN.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -229,20 +229,39 @@ rux 中你可以添加命名路由,根据名称可以从路由器里拿到对
229229
### 重定向跳转
230230

231231
```go
232-
r.GET("/", func(c *rux.Context) {
233-
c.AbortThen().Redirect("/login", 302)
234-
})
235-
236-
// Or
237-
r.GET("/", func(c *rux.Context) {
238-
c.Redirect("/login", 302)
239-
c.Abort()
240-
})
232+
r.GET("/", func(c *rux.Context) {
233+
c.AbortThen().Redirect("/login", 302)
234+
})
235+
236+
// Or
237+
r.GET("/", func(c *rux.Context) {
238+
c.Redirect("/login", 302)
239+
c.Abort()
240+
})
241+
242+
r.GET("/", func(c *rux.Context) {
243+
c.Back()
244+
c.Abort()
245+
})
246+
```
241247

242-
r.GET("/", func(c *rux.Context) {
243-
c.Back()
244-
c.Abort()
245-
})
248+
### 操作Cookies
249+
250+
您可以通过以下方式快速操作Cookies `FastSetCookie()` `DelCookie()`
251+
252+
> 注意:您必须先设置或删除Cookies,然后再调用写入BODY内容的相关方法
253+
254+
```go
255+
r.GET("/setcookie", func(c *rux.Context) {
256+
c.FastSetCookie("rux_cookie2", "test-value2", 3600)
257+
c.SetCookie("rux_cookie", "test-value1", 3600, "/", c.Req.URL.Host, false, true)
258+
c.WriteString("hello, in " + c.URL().Path)
259+
})
260+
261+
r.GET("/delcookie", func(c *rux.Context) {
262+
val := ctx.Cookie("rux_cookie") // "test-value1"
263+
c.DelCookie("rux_cookie", "rux_cookie2")
264+
})
246265
```
247266

248267
### 多个域名

_examples/go.mod

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ module bench
22

33
go 1.12
44

5-
require github.com/gookit/rux v0.0.1
5+
require (
6+
github.com/gookit/rux v0.0.1
7+
github.com/valyala/fasthttp v1.15.1 // indirect
8+
)
69

710
replace github.com/gookit/rux => ../

_examples/go.sum

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
2+
github.com/andybalholm/brotli v1.0.0 h1:7UCwP93aiSfvWpapti8g88vVVGp2qqtGyePsSuDafo4=
3+
github.com/andybalholm/brotli v1.0.0/go.mod h1:loMXtMfwqflxFJPmdbJO0a3KNoPuLBgiu3qAvBg8x/Y=
24
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
35
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
46
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
@@ -20,6 +22,8 @@ github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/u
2022
github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
2123
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
2224
github.com/klauspost/compress v1.8.2/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=
25+
github.com/klauspost/compress v1.10.7 h1:7rix8v8GpI3ZBb0nSozFRgbtXKv+hOe+qfEpZqybrAg=
26+
github.com/klauspost/compress v1.10.7/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs=
2327
github.com/klauspost/cpuid v1.2.1/go.mod h1:Pj4uuM528wm8OyEC2QMXAi2YiTZ96dNQPGgoMS4s3ek=
2428
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
2529
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
@@ -32,19 +36,25 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
3236
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
3337
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
3438
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
39+
github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
3540
github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
3641
github.com/valyala/fasthttp v1.10.0/go.mod h1:FstJa9V+Pj9vQ7OJie2qMHdwemEDaDiSdBnvPM1Su9w=
42+
github.com/valyala/fasthttp v1.15.1 h1:eRb5jzWhbCn/cGu3gNJMcOfPUfXgXCcQIOHjh9ajAS8=
43+
github.com/valyala/fasthttp v1.15.1/go.mod h1:YOKImeEosDdBPnxc0gy7INqi3m1zK6A+xl6TwOBhHCA=
3744
github.com/valyala/tcplisten v0.0.0-20161114210144-ceec8f93295a/go.mod h1:v3UYOV9WzVtRmSR+PDvWpU/qWl4Wa5LApYYX4ZtKbio=
3845
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
3946
golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
4047
golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
4148
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
4249
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
4350
golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
51+
golang.org/x/net v0.0.0-20200602114024-627f9648deb9/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
4452
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
4553
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
4654
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
4755
golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
56+
golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
57+
golang.org/x/sys v0.0.0-20200602225109-6fdc65e7d980/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
4858
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
4959
golang.org/x/tools v0.0.0-20191130070609-6e064ea0cf2d/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
5060
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

_examples/multi-port/main.go renamed to _examples/multiport/main.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ const (
1313

1414
var wg sync.WaitGroup
1515

16+
// multi port listen
1617
func main() {
1718
http.HandleFunc("/", Hello)
1819

0 commit comments

Comments
 (0)