Skip to content

Commit

Permalink
Change Logo and improve README document
Browse files Browse the repository at this point in the history
  • Loading branch information
gitlayzer committed Mar 24, 2024
1 parent 60fd4cf commit 25615fa
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 15 deletions.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 - /
```
30 changes: 15 additions & 15 deletions logo.go
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
package gee

const Logo = `
*** *** ** ** **
***** *** *** ** **
******* *** *** ** **
*** ** *** *** ** **
*** *** ** *** ** **
*** *** ***** ***** ****** ** ***** *******
** ******* ******* ********* ******* ********
** ***** *** ** *** ** **** **** *** ** *** ***
** ***** ********* ********* **** *** ********* ** ***
** *** ********* ********* **** *** ********* ** ***
*** *** ** ** **** *** ** ** ***
*** *** *** *** *** *** **** *** *** *** *** **
******** **** *** **** *** ** *** **** *** **** ***
******** ******* ******* ** *** ******* *******
*** ** *** *** ** *** *** ** ***
***
*****
*******
*** **
*** ***
*** *** ***** *****
** ******* *******
** ***** *** ** *** **
** ***** ********* *********
** *** ********* *********
*** *** ** **
*** *** *** *** *** ***
******** **** *** **** ***
******** ******* *******
*** ** *** ***
`

0 comments on commit 25615fa

Please sign in to comment.