diff options
-rw-r--r-- | README.md | 24 |
1 files changed, 15 insertions, 9 deletions
@@ -1,15 +1,15 @@ | |||
1 | # Synopsis | 1 | # Synopsis |
2 | 2 | ||
3 | BEncode is JSON-like format used in bittorrent protocol but might be | 3 | [BEncode][bencode] is [JSON][json-ref]-like format used in bittorrent |
4 | used anywhere else. | 4 | protocol but might be used anywhere else. |
5 | 5 | ||
6 | # Description | 6 | # Description |
7 | 7 | ||
8 | This package implements fast seamless encoding/decoding to/from | 8 | This package implements fast seamless encoding/decoding to/from |
9 | bencode format for many native datatypes. To achive | 9 | bencode format for many native datatypes. To achive |
10 | [more performance][1] we use new bytestring builders and hand | 10 | [more performance][cmp] we use [bytestring builders][bytestring-builder] |
11 | optimized attoparsec parser so this library is considered as | 11 | and hand optimized [attoparsec][attoparsec] parser so this library is |
12 | replacement for BEncode and AttoBencode packages. | 12 | considered as replacement for BEncode and AttoBencode packages. |
13 | 13 | ||
14 | ## Format | 14 | ## Format |
15 | 15 | ||
@@ -40,7 +40,7 @@ For documentation see haddock generated documentation. | |||
40 | 40 | ||
41 | # Build Status | 41 | # Build Status |
42 | 42 | ||
43 | [![Build Status][2]][3] | 43 | [![Build Status][travis-img]][travis-log] |
44 | 44 | ||
45 | # Authors | 45 | # Authors |
46 | 46 | ||
@@ -48,6 +48,12 @@ This library is written and maintained by Sam T. <pxqr.sta@gmail.com> | |||
48 | Feel free to report bugs and suggestions via github issue tracker or the mail. | 48 | Feel free to report bugs and suggestions via github issue tracker or the mail. |
49 | 49 | ||
50 | 50 | ||
51 | [1]: http://htmlpreview.github.com/?https://github.com/pxqr/bencoding/master/bench/comparison.html | 51 | [cmp]: http://htmlpreview.github.com/?https://github.com/pxqr/bencoding/master/bench/comparison.html |
52 | [2]: https://travis-ci.org/pxqr/bencoding.png | 52 | |
53 | [3]: https://travis-ci.org/pxqr/bencoding | 53 | [bencode]: https://wiki.theory.org/BitTorrentSpecification#Bencoding |
54 | [json-ref]: http://www.json.org/ | ||
55 | [attoparsec]: http://hackage.haskell.org/package/attoparsec-0.10.4.0 | ||
56 | [bytestring-builder]: http://hackage.haskell.org/packages/archive/bytestring/0.10.2.0/doc/html/Data-ByteString-Builder.html | ||
57 | |||
58 | [travis-img]: https://travis-ci.org/pxqr/bencoding.png | ||
59 | [travis-log]: https://travis-ci.org/pxqr/bencoding | ||