go/json-iterator
1
0
Fork 0
mirror of https://github.com/json-iterator/go.git synced 2025-02-07 19:30:06 +02:00
Code Issues Releases Activity

update README

Browse Source
This commit is contained in:
Tao Wen 2016-12-12 08:08:37 +08:00
parent 86e44a71ad
commit 160fdc6584
1 changed files with 47 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -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)