From: mh-cbon <mh-cbon@users.noreply.github.com>
Date: Tue, 5 Sep 2017 14:42:37 +0000 (+0200)
Subject: Update README
X-Git-Tag: v1.0.0~408^2~3^2
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=54a3090f7e107580e5fd0919e0ae31389099d863;p=btrtrc.git

Update README
---

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)
+}
+```