Skip to content

Commit 176d70d

Browse files
authored
docs: update docs
1 parent 8c834ac commit 176d70d

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@
44

55
### Kid Micro Web Framework
66
___
7-
**Kid** is a micro web framework written in Go. It aims to keep its core simple and yet powerful.
7+
**Kid** is a micro web framework written in Go. It aims to keep its core simple and yet powerful. It's fully compatible with net/http interfaces and can be adapt with other net/http compatible packages as well.
8+
9+
### Routing
10+
It uses a tree-based routing with a DFS traversal algorithm.
11+
12+
### Versioning
13+
This package follows semver versioning.
814

915
#### Quick Start
1016
___
@@ -34,15 +40,3 @@ func helloHandler(c *kid.Context) {
3440
c.JSON(http.StatusOK, kid.Map{"message": "Hello Kid!"})
3541
}
3642
```
37-
38-
#### TODOs
39-
___
40-
41-
- [x] Add test cases up to +90% coverage.
42-
- [ ] Complete docs.
43-
- [x] Add more methods for sending response like XML, HTML, etc.
44-
- [ ] Add some middlewares like `Logger`, `Recovery`, etc.
45-
- [x] Add CI.
46-
- [x] Add comments.
47-
- [x] Add methods to serve static files.
48-
- [ ] Add validator.

0 commit comments

Comments
 (0)