diff --git a/README.md b/README.md index 2e50db9..ddf8c73 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,62 @@ Gee API Framework encapsulates the net/http framework, making it easier and fast ### Prerequisites - **[Go](https://go.dev/)**: any one of the **three latest major** [releases](https://go.dev/doc/devel/release) (we test it with these). + +### Getting Gee +``` +import "github.com/gitlayzer/gee_api_framework" +``` + +to your code, and then go [build|run|test] will automatically fetch the necessary dependencies. + +Otherwise, run the following Go command to install the `gin` package: + +```sh +$ go get -u github.com/gitlayzer/gee_api_framework +``` + +### Running Gee +First you need to import Gee package for using Gee, one simplest example likes the follow `main.go`: + +```go +package main + +import gee "github.com/gitlayzer/gee_api_framework" + +func main() { + r := gee.Default() + + r.GET("/", func(c *gee.Context) { + c.JSON(200, gee.H{ + "message": "Hello Gee", + }) + }) + + _ = r.Run(":8888") +} +``` + +And use the Go command to run the demo: +``` +Administrator in E:\codes\web_server 15s +❯ go run .\main.go + + *** + ***** + ******* + *** ** + *** *** + *** *** ***** ***** + ** ******* ******* + ** ***** *** ** *** ** + ** ***** ********* ********* + ** *** ********* ********* + *** *** ** ** + *** *** *** *** *** *** + ******** **** *** **** *** + ******** ******* ******* + *** ** *** *** + +2024/03/24 16:07:13 [Gee] GET - / + +``` \ No newline at end of file diff --git a/logo.go b/logo.go index 318d56a..0a5b711 100644 --- a/logo.go +++ b/logo.go @@ -1,19 +1,19 @@ package gee const Logo = ` - *** *** ** ** ** - ***** *** *** ** ** - ******* *** *** ** ** - *** ** *** *** ** ** - *** *** ** *** ** ** - *** *** ***** ***** ****** ** ***** ******* - ** ******* ******* ********* ******* ******** - ** ***** *** ** *** ** **** **** *** ** *** *** - ** ***** ********* ********* **** *** ********* ** *** - ** *** ********* ********* **** *** ********* ** *** - *** *** ** ** **** *** ** ** *** - *** *** *** *** *** *** **** *** *** *** *** ** - ******** **** *** **** *** ** *** **** *** **** *** - ******** ******* ******* ** *** ******* ******* - *** ** *** *** ** *** *** ** *** + *** + ***** + ******* + *** ** + *** *** + *** *** ***** ***** + ** ******* ******* + ** ***** *** ** *** ** + ** ***** ********* ********* + ** *** ********* ********* + *** *** ** ** + *** *** *** *** *** *** + ******** **** *** **** *** + ******** ******* ******* + *** ** *** *** `