Skip to content

Commit 51cd8d9

Browse files
committed
Update readme
1 parent e73b8cc commit 51cd8d9

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44
[![GoDoc](https://godoc.org/github.com/gamegos/jsend?status.svg)](http://godoc.org/github.com/gamegos/jsend)
55

66

7-
Simple golang **JSend** library.
8-
9-
See http://labs.omniti.com/labs/jsend for JSend details.
7+
Golang **JSend** library
108

119

1210
## Installation
@@ -20,7 +18,23 @@ $ go get github.com/gamegos/jsend
2018
import "github.com/gamegos/jsend"
2119
```
2220

23-
See [godoc](http://godoc.org/github.com/gamegos/jsend)
21+
See [API documentation](http://godoc.org/github.com/gamegos/jsend)
22+
23+
## Format
24+
25+
Jsend is a very simple json format to wrap your json responses.
26+
27+
```json
28+
{
29+
"status": "success|fail|error",
30+
"data": {
31+
"your data": "here..."
32+
},
33+
"message": "error message when status is error"
34+
}
35+
```
36+
37+
See [JSend specification](http://labs.omniti.com/labs/jsend) for details.
2438

2539

2640
## License

0 commit comments

Comments
 (0)