From: Matt Joiner <anacrolix@gmail.com>
Date: Fri, 20 Mar 2015 12:18:09 +0000 (+1100)
Subject: Improve the README
X-Git-Tag: v1.0.0~1257
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=73d8eef468cda50133f5fc4c78fb7cd50c0de5ad;p=btrtrc.git

Improve the README
---

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..fff7242a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# torrent
+
+[![Codeship](https://www.codeship.io/projects/a2811d30-b0ce-0132-8983-5e604f7ebe37/status)](https://codeship.com/projects/69674)
+[![GoDoc](https://godoc.org/github.com/anacrolix/torrent?status.svg)](https://godoc.org/github.com/anacrolix/torrent)
+
+This repository implements BitTorrent-related packages and command-line utilities in Go.
+
+There is support for protocol encryption, DHT, PEX, uTP, and various extensions. There are several storage backends provided, blob, file, mmap. You can use the provided binaries in `./cmd`, or use `torrent` as a library for your own applications.
+
+## Installation
+
+Install the library package with `go get github.com/anacrolix/torrent`, or one of the provided cmds with `go get github.com/anacrolix/...`.
+
+## Library example
+
+There is a small example in the [package documentation](https://godoc.org/github.com/anacrolix/torrent).
+
+## Torrent utility
+
+There's a provided utility that downloads torrents from the command-line.
+
+	$ go get github.com/anacrolix/torrent/cmd/torrent
+	$ torrent 'magnet:?xt=urn:btih:ZOCMZQIPFFW7OLLMIC5HUB6BPCSDEOQU'
+    2015/03/20 22:51:41 main.go:96: downloaded ALL the torrents
+    $ md5sum ubuntu-14.04.1-desktop-amd64.iso
+    119cb63b48c9a18f31f417f09655efbd  ubuntu-14.04.1-desktop-amd64.iso
+    $ echo such amaze
+    wow
\ No newline at end of file
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 6926008c..00000000
--- a/README.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. image:: https://www.codeship.io/projects/a2811d30-b0ce-0132-8983-5e604f7ebe37/status