]> Sergey Matveev's repositories - btrtrc.git/commitdiff
Update README
authormh-cbon <mh-cbon@users.noreply.github.com>
Tue, 5 Sep 2017 14:42:37 +0000 (16:42 +0200)
committerGitHub <noreply@github.com>
Tue, 5 Sep 2017 14:42:37 +0000 (16:42 +0200)
bencode/README

index 440bd5f74b4d7206ade48a499697eb5fe6a5a282..4dbc67bebf663800506d47eb05bf8b69c5989f43 100644 (file)
@@ -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)
+}
+```