From 54a3090f7e107580e5fd0919e0ae31389099d863 Mon Sep 17 00:00:00 2001 From: mh-cbon Date: Tue, 5 Sep 2017 16:42:37 +0200 Subject: [PATCH] Update README --- bencode/README | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/bencode/README b/bencode/README index 440bd5f7..4dbc67be 100644 --- a/bencode/README +++ b/bencode/README @@ -1 +1,38 @@ Bencode encoding/decoding sub package. Uses similar API design to Go's json package. + +## Install + +```sh +go get github.com/anacrolix/torrent +``` + +## Usage + +```go +package demo + +import ( + bencode "github.com/anacrolix/torrent/bencode" +) + +type Message struct { + Query string `json:"q,omitempty" bencode:"q,omitempty"` +} + +var v Message + +func main(){ + // encode + data, err := bencode.Marshal(v) + if err != nil { + log.Fatal(err) + } + + //decode + err := bencode.Unmarshal(data, &v) + if err != nil { + log.Fatal(err) + } + fmt.Println(v) +} +```