Updated documentation
This commit is contained in:
parent
525cf89539
commit
8330e688e2
25
README.md
25
README.md
@ -4,7 +4,8 @@ HTTP server.
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Specificity based routing
|
- Low latency
|
||||||
|
- Radix tree routing
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@ -17,33 +18,22 @@ go get git.akyoto.dev/go/server
|
|||||||
```go
|
```go
|
||||||
s := server.New()
|
s := server.New()
|
||||||
|
|
||||||
// Add your routes here.
|
// Static route
|
||||||
|
|
||||||
http.ListenAndServe(":8080", s)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Static
|
|
||||||
|
|
||||||
```go
|
|
||||||
s.Get("/", func(ctx server.Context) error {
|
s.Get("/", func(ctx server.Context) error {
|
||||||
return ctx.String("Hello")
|
return ctx.String("Hello")
|
||||||
})
|
})
|
||||||
```
|
|
||||||
|
|
||||||
### Parameter
|
// Parameter route
|
||||||
|
|
||||||
```go
|
|
||||||
s.Get("/blog/:post", func(ctx server.Context) error {
|
s.Get("/blog/:post", func(ctx server.Context) error {
|
||||||
return ctx.String(ctx.Get("post"))
|
return ctx.String(ctx.Get("post"))
|
||||||
})
|
})
|
||||||
```
|
|
||||||
|
|
||||||
### Wildcard
|
// Wildcard route
|
||||||
|
|
||||||
```go
|
|
||||||
s.Get("/images/*file", func(ctx server.Context) error {
|
s.Get("/images/*file", func(ctx server.Context) error {
|
||||||
return ctx.String(ctx.Get("file"))
|
return ctx.String(ctx.Get("file"))
|
||||||
})
|
})
|
||||||
|
|
||||||
|
http.ListenAndServe(":8080", s)
|
||||||
```
|
```
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
@ -57,6 +47,7 @@ coverage: 100.0% of statements
|
|||||||
## Benchmarks
|
## Benchmarks
|
||||||
|
|
||||||
```
|
```
|
||||||
|
coming soon
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
Loading…
Reference in New Issue
Block a user