Ver código fonte

codec: update docs to reference usage/how-to primer.

Ugorji Nwoke 11 anos atrás
pai
commit
0f329cb48e
3 arquivos alterados com 15 adições e 6 exclusões
  1. 11 5
      README.md
  2. 2 0
      codec/0doc.go
  3. 2 1
      codec/README.md

+ 11 - 5
README.md

@@ -1,12 +1,18 @@
-# go
+# go/codec
 
 
-Collection of Open-Source Go libraries and tools.
+This repository contains the `go-codec` library,
+a High Performance and Feature-Rich Idiomatic encode/decode and rpc library for
 
 
-## Codec
+  - msgpack: https://github.com/msgpack/msgpack
+  - binc:    http://github.com/ugorji/binc
+  - cbor:    http://cbor.io http://tools.ietf.org/html/rfc7049
+  - json:    http://json.org http://tools.ietf.org/html/rfc7159 
 
 
-[Codec](https://github.com/ugorji/go/tree/master/codec#readme) is a High Performance and Feature-Rich Idiomatic encode/decode and rpc library for [msgpack](http://msgpack.org) and [Binc](https://github.com/ugorji/binc).
+For more information:
 
 
-Online documentation is at [http://godoc.org/github.com/ugorji/go/codec].
+  - [see the Readme on github](https://github.com/ugorji/go/tree/master/codec#readme)
+  - [view the API on godoc](http://godoc.org/github.com/ugorji/go/codec)
+  - [read the detailed usage/how-to primer](http://ugorji.net/blog/go-codec-primer)
 
 
 Install using:
 Install using:
 
 

+ 2 - 0
codec/0doc.go

@@ -17,6 +17,8 @@ To install:
 
 
     go get github.com/ugorji/go/codec
     go get github.com/ugorji/go/codec
 
 
+For detailed usage information, read the primer at http://ugorji.net/blog/go-codec-primer .
+
 The idiomatic Go support is as seen in other encoding packages in
 The idiomatic Go support is as seen in other encoding packages in
 the standard library (ie json, xml, gob, etc).
 the standard library (ie json, xml, gob, etc).
 
 

+ 2 - 1
codec/README.md

@@ -15,7 +15,8 @@ To install:
 
 
     go get github.com/ugorji/go/codec
     go get github.com/ugorji/go/codec
 
 
-Online documentation: http://godoc.org/github.com/ugorji/go/codec
+Online documentation: http://godoc.org/github.com/ugorji/go/codec  
+Detailed Usage/How-to Primer: http://ugorji.net/blog/go-codec-primer
 
 
 The idiomatic Go support is as seen in other encoding packages in
 The idiomatic Go support is as seen in other encoding packages in
 the standard library (ie json, xml, gob, etc).
 the standard library (ie json, xml, gob, etc).