From: Matt Joiner Date: Fri, 29 Oct 2021 00:57:57 +0000 (+1100) Subject: Link to godocs.io for documentation X-Git-Tag: v1.35.0~10 X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=c2ed60f9f2d100ddd15a38a6c260121a9ad6e893;p=btrtrc.git Link to godocs.io for documentation --- diff --git a/README.md b/README.md index e821755e..a4908357 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # torrent -[![PkgGoDev](https://pkg.go.dev/badge/github.com/anacrolix/torrent)](https://pkg.go.dev/github.com/anacrolix/torrent) +[![godocs.io](https://godocs.io/github.com/anacrolix/torrent?status.svg)](https://godocs.io/github.com/anacrolix/torrent) This repository implements BitTorrent-related packages and command-line utilities in Go. The emphasis is on use as a library from other projects. It's been used 24/7 in production by downstream services since late 2014. The implementation was specifically created to explore Go's concurrency capabilities, and to include the ability to stream data directly from the BitTorrent network. To this end it [supports seeking, readaheads and other features](https://godoc.org/github.com/anacrolix/torrent#Reader) exposing torrents and their files with the various Go idiomatic `io` package interfaces. This is also demonstrated through [torrentfs](#torrentfs).