Skip to content

Commit

Permalink
update readme description for publish.
Browse files Browse the repository at this point in the history
  • Loading branch information
netmarkjp committed Nov 9, 2014
1 parent 2014430 commit 454c7e7
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
kagenui
============

kagenui is profiler for golang
kagenui is profiler and analyzer for golang

Good for use with web application.

Expand All @@ -16,17 +16,27 @@ go get github.com/netmarkjp/kagenui
```
import "github.com/netmarkjp/kagenui"
func someHandler(w http.ResponseWriter, r *http.Request) {
func SomeHandler(){
mp := kagenui.Begin("someHandler")
defer mp.End()
...
mp.Step("exec XXX")
...
if valid {
mp.AddMemo("cache is valid")
...
} else {
mp.AddMemo("cache is invalid")
...
}
...
mp.Step("exec YYY")
}
func profileHandler(w http.ResponseWriter, r *http.Request) {
Expand Down Expand Up @@ -77,7 +87,7 @@ Dump Output
ltsv format

```
log:MP<TAB><DESCRIPTION_AT_STEP>:<SPENT_TIME_IN_NANOSEC><TAB>...<TAB>description:<DESCRIPTION_AT_BEGIN><TAB>memo:<MEMO>
log:MP<TAB><DESCRIPTION_AT_STEP>:<SPENT_TIME_IN_NANOSEC><TAB>...<TAB>description:<DESCRIPTION_AT_BEGIN><TAB>memo:<MEMO1>,<MEMO2>,...
```

Customize
Expand Down

0 comments on commit 454c7e7

Please sign in to comment.