소스 검색

update README

Tao Wen 9 년 전
부모
커밋
160fdc6584
1개의 변경된 파일47개의 추가작업 그리고 4개의 파일을 삭제
  1. 47 4
      README.md

+ 47 - 4
README.md

@@ -2,8 +2,51 @@ jsoniter (json-iterator) is fast and flexible JSON parser available in [Java](ht
 
 # Why jsoniter?
 
-* Jsoniter is the fastest JSON parser, it could be up to 10x faster than normal parser, data binding included (shameless self [benchmark](http://jsoniter.com/benchmark.html))
-* Having a developer friendly api is our #1 prioprity, you can choose from bind-api, any-api or iterator-api or all of them (checkout your [api choices](http://jsoniter.com/api.html))
-* Unique iterator api can iterate through JSON directly, zero memory allocation! (see how [iterator](http://jsoniter.com/api.html#iterator-api) works)
+* Jsoniter is the fastest JSON parser, it could be up to 10x faster than normal parser, data binding included (shameless self [benchmark](/benchmark.html))
+* Having a developer friendly api is our #1 prioprity, you can choose from bind-api, any-api or iterator-api or all of them (checkout your [api choices](/api.html))
+* Unique iterator api can iterate through JSON directly, zero memory allocation! (see how [iterator](/api.html#iterator-api) works)
 
-Join us [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/json-iterator/Lobby)
+# 1 Minute Tutorial
+
+Given this JSON document `[0,1,2,3]`
+
+Parse with Go bind-api
+
+```go
+import "github.com/json-iterator/go"
+iter := jsoniter.ParseString(`[0,1,2,3]`)
+val := []int{}
+iter.Read(&val)
+fmt.Println(val[3])
+```
+
+Parse with Go any-api
+
+```go
+import "github.com/json-iterator/go"
+iter := jsoniter.ParseString(`[0,1,2,3]`)
+val := iter.ReadAny()
+fmt.Println(val.Get(3))
+```
+
+Parse with Go iterator-api
+
+```go
+import "github.com/json-iterator/go"
+iter := ParseString(`[0,1,2,3]`)
+total := 0
+for iter.ReadArray() {
+    total += iter.ReadInt()
+}
+fmt.Println(total)
+```
+
+# How to get
+
+```
+go get github.com/json-iterator/go
+```
+
+# Contribution Welcomed !
+
+Report issue or pull request, or email taowen@gmail.com, or [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/json-iterator/Lobby)