Mirror/bittorrent-tracker
1
0
Fork 0
mirror of https://github.com/webtorrent/bittorrent-tracker.git synced 2025-01-18 20:21:36 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

readme formatting

Browse Source
This commit is contained in:
Feross Aboukhadijeh 2014-03-27 00:39:14 -07:00
parent 7622bdb581
commit 4a448bb017
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,6 +1,6 @@
# bittorrent-tracker [![build](http://img.shields.io/travis/feross/bittorrent-tracker.svg)](https://travis-ci.org/feross/bittorrent-tracker) [![npm](http://img.shields.io/npm/v/bittorrent-tracker.svg)](https://npmjs.org/package/bittorrent-tracker) [![gittip](http://img.shields.io/gittip/feross.svg)](https://www.gittip.com/feross/)
### Simple, robust, BitTorrent tracker (client & server) implementation
#### Simple, robust, BitTorrent tracker (client & server) implementation
Node.js implementation of a [BitTorrent tracker](https://wiki.theory.org/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol), client and server.
@ -12,13 +12,15 @@ participate in the torrent.
Also see [bittorrent-dht](https://github.com/feross/bittorrent-dht). This module is used
by [WebTorrent](http://webtorrent.io).
## install
### install
```
npm install bittorrent-tracker
```
## usage
### usage
#### client
To connect to a tracker, just do this:
@ -63,7 +65,9 @@ client.update()
client.stop()
```
**TODO: Add a BitTorrent tracker server implementation to this package.**
#### server
To start a BitTorrent tracker server to track swarms of peers:
```js
var Server = require('bittorrent-tracker').Server