Skip to content

Commit 4a448bb

Browse files
committed
readme formatting
1 parent 7622bdb commit 4a448bb

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 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/)
22

3-
### Simple, robust, BitTorrent tracker (client & server) implementation
3+
#### Simple, robust, BitTorrent tracker (client & server) implementation
44

55
Node.js implementation of a [BitTorrent tracker](https://wiki.theory.org/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol), client and server.
66

@@ -12,13 +12,15 @@ participate in the torrent.
1212
Also see [bittorrent-dht](https://github.com/feross/bittorrent-dht). This module is used
1313
by [WebTorrent](http://webtorrent.io).
1414

15-
## install
15+
### install
1616

1717
```
1818
npm install bittorrent-tracker
1919
```
2020

21-
## usage
21+
### usage
22+
23+
#### client
2224

2325
To connect to a tracker, just do this:
2426

@@ -63,7 +65,9 @@ client.update()
6365
client.stop()
6466
```
6567

66-
**TODO: Add a BitTorrent tracker server implementation to this package.**
68+
#### server
69+
70+
To start a BitTorrent tracker server to track swarms of peers:
6771

6872
```js
6973
var Server = require('bittorrent-tracker').Server

0 commit comments

Comments
 (0)