Skip to content

Commit e06ba7c

Browse files
committed
📝 update doc
1 parent 807f878 commit e06ba7c

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# GOE
22

33
GOE is a simple and easy to use web development framework for Go. It is designed to be simple and easy to use, and to be
4-
able to quickly build a web application. It is based on the [GoFiber](https://gofiber.io/) framework, and adds some
4+
able to quickly build a web application. It is based on the [GoFiber](https://gofiber.io/) v3 framework, and adds some
55
useful features.
66

77
GOE learned from practices of Golang projects, Java web development frameworks, such as Spring Boot, and tried to
@@ -17,7 +17,7 @@ Thanks for the following projects that GOE relies on or inspired by:
1717
- [PocketBase](https://pocketbase.io/) - For the mailer implementation and interface design.
1818
- [Delayqueue](https://github.com/HDT3213/delayqueue) - For the message queue implementation.
1919
- [Zap](https://github.com/uber-go/zap) - For the logger implementation.
20-
- [Kelindar Event](https://github.com/kelindar/event) - For the event bus implementation.
20+
- ~~[Kelindar Event](https://github.com/kelindar/event) - For the event bus implementation.~~
2121

2222
## Goals
2323

@@ -26,12 +26,7 @@ focus on the business logic, and GOE will handle the rest.
2626

2727
## Supported Database
2828

29-
Currently, GOE only supports MongoDB. Will support more SQL databases in the future.
30-
31-
## Plans
32-
33-
- [ ] Code Generator, to generate the project structure and code.
34-
- [ ] gRPC Support, based on Buf.
29+
Currently, GOE only supports MongoDB.
3530

3631
## Quick Start
3732

@@ -68,4 +63,6 @@ func main() {
6863
return
6964
}
7065
}
71-
```
66+
```
67+
68+
read more in [example](https://github.com/oeasenet/goe/tree/main/example)

0 commit comments

Comments
 (0)