From f264fd9de90a7a16d5c8db99dd897d76c5f565f8 Mon Sep 17 00:00:00 2001 From: John Guo Date: Tue, 26 Nov 2024 22:27:32 +0800 Subject: [PATCH 1/3] feat: README updates --- README.MD | 66 ++++++++----------------------------------------------- 1 file changed, 9 insertions(+), 57 deletions(-) diff --git a/README.MD b/README.MD index 1ffeca6ec13..128bb0e4c45 100644 --- a/README.MD +++ b/README.MD @@ -1,4 +1,3 @@ -# GoFrame
@@ -20,73 +19,26 @@
-`GoFrame` is a modular, powerful, high-performance and enterprise-class application development framework of Golang. +A powerful framework for faster, easier, and more efficient project development. -# Features -- modular, loosely coupled design -- rich components, out-of-the-box -- automatic codes generating for efficiency -- simple and easy to use, detailed documentation -- interface designed components, with high scalability -- fully supported tracing and error stack feature -- specially developed and powerful ORM component -- robust engineering design specifications -- convenient development CLI tool provide -- OpenTelemetry observability features support -- OpenAPIV3 documentation generating, automatically -- much, much more...ready to explore? - -# Documentation +## Documents - GoFrame Official Site: [https://goframe.org](https://goframe.org) +- GoFrame Official Site(en): [https://goframe.org/en](https://goframe.org/en) +- GoFrame Mirror Site(δΈ­ζ–‡): [https://goframe.org.cn](https://goframe.org.cn) +- GoFrame Mirror Site(github pages): [https://pages.goframe.org](https://pages.goframe.org) - GoDoc API: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2) -# Installation - -Enter your repo. directory and execute following command: - -## primary module - -```bash -go get -u -v github.com/gogf/gf/v2 -``` - -## cli tool - -```bash -go install github.com/gogf/gf/cmd/gf/v2@latest -``` - -# Limitation - -``` -golang version >= 1.20 -``` +## Contributors -# Contributors - -πŸ’– Thanks all the contributors making GoFrame awesome! [[Contributors](https://github.com/gogf/gf/graphs/contributors)] πŸ’– +πŸ’– [Thanks to all the contributors who made GoFrame possible](https://github.com/gogf/gf/graphs/contributors) πŸ’– - + -# License +## License `GoFrame` is licensed under the [MIT License](LICENSE), 100% free and open-source, forever. - - -# Donators - -If you love `GoFrame`, why not [buy developer a cup of coffee](https://goframe.org/supportus/donate)? - -# Sponsors - -We appreciate any kind of sponsorship for `GoFrame` development. If you've got some interesting, please contact WeChat `389961817` / Email `john@goframe.org`. - -# Thanks - -JetBrains -Atlassian From 700fa2f20dc5fe109750632e5fc6837b743114b5 Mon Sep 17 00:00:00 2001 From: John Guo Date: Tue, 26 Nov 2024 22:29:21 +0800 Subject: [PATCH 2/3] feat: README updates --- README.MD | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.MD b/README.MD index 128bb0e4c45..546fbcb6c48 100644 --- a/README.MD +++ b/README.MD @@ -22,7 +22,7 @@ A powerful framework for faster, easier, and more efficient project development. -## Documents +# Documents - GoFrame Official Site: [https://goframe.org](https://goframe.org) - GoFrame Official Site(en): [https://goframe.org/en](https://goframe.org/en) @@ -31,7 +31,7 @@ A powerful framework for faster, easier, and more efficient project development. - GoDoc API: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2) -## Contributors +# Contributors πŸ’– [Thanks to all the contributors who made GoFrame possible](https://github.com/gogf/gf/graphs/contributors) πŸ’– @@ -39,6 +39,6 @@ A powerful framework for faster, easier, and more efficient project development. -## License +# License `GoFrame` is licensed under the [MIT License](LICENSE), 100% free and open-source, forever. From d7da2187bc58227e4b348d9e9f96f53117584110 Mon Sep 17 00:00:00 2001 From: John Guo Date: Wed, 27 Nov 2024 14:23:57 +0800 Subject: [PATCH 3/3] feat: README updates --- README.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.MD b/README.MD index 546fbcb6c48..5c2db9daab4 100644 --- a/README.MD +++ b/README.MD @@ -22,7 +22,7 @@ A powerful framework for faster, easier, and more efficient project development. -# Documents +# Documentation - GoFrame Official Site: [https://goframe.org](https://goframe.org) - GoFrame Official Site(en): [https://goframe.org/en](https://goframe.org/en)