diff options
-rw-r--r-- | README.md | 35 | ||||
-rw-r--r-- | bencoding.cabal | 6 |
2 files changed, 22 insertions, 19 deletions
@@ -1,17 +1,18 @@ | |||
1 | # Synopsis | 1 | ### Synopsis |
2 | 2 | ||
3 | [BEncode][bencode] is [JSON][json-ref]-like format used in bittorrent | 3 | [BEncode][bencode] is [JSON][json-ref]-like format used in bittorrent |
4 | protocol but might be 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][cmp] we use [bytestring builders][bytestring-builder] | 10 | [more performance][cmp] we use |
11 | and hand optimized [attoparsec][attoparsec] parser so this library is | 11 | [bytestring builders][bytestring-builder] and hand optimized |
12 | considered as replacement for BEncode and AttoBencode packages. | 12 | [attoparsec][attoparsec] parser so this library is considered as |
13 | replacement for BEncode and AttoBencode packages. | ||
13 | 14 | ||
14 | ## Format | 15 | #### Format |
15 | 16 | ||
16 | Bencode is pretty similar to JSON: it has dictionaries(JSON objects), | 17 | Bencode is pretty similar to JSON: it has dictionaries(JSON objects), |
17 | lists(JSON arrays), strings and integers. However bencode has a few | 18 | lists(JSON arrays), strings and integers. However bencode has a few |
@@ -31,27 +32,29 @@ Hovewer there are some disadvantages comparing with JSON: | |||
31 | * Bencode is certainly less human readable. | 32 | * Bencode is certainly less human readable. |
32 | * Bencode is rarely used, except bittorrent protocol of course. | 33 | * Bencode is rarely used, except bittorrent protocol of course. |
33 | 34 | ||
34 | # Documentation | 35 | ### Documentation |
35 | 36 | ||
36 | For documentation see haddock generated documentation. | 37 | For documentation see package [hackage][hackage] page. |
37 | 38 | ||
38 | # Build Status | 39 | ### Build Status |
39 | 40 | ||
40 | [![Build Status][travis-img]][travis-log] | 41 | [![Build Status][travis-img]][travis-log] |
41 | 42 | ||
42 | # Authors | 43 | ### Maintainer <pxqr.sta@gmail.com> |
43 | 44 | ||
44 | This library is written and maintained by Sam T. <pxqr.sta@gmail.com> | 45 | Feel free to report bugs and suggestions via [issue tracker][issues] |
46 | or the mail. | ||
45 | 47 | ||
46 | Feel free to report bugs and suggestions via github issue tracker or the mail. | ||
47 | 48 | ||
48 | 49 | [cmp]: http://htmlpreview.github.com/?https://raw.github.com/wiki/cobit/bencoding/comparison.html | |
49 | [cmp]: http://htmlpreview.github.com/?https://github.com/pxqr/bencoding/master/bench/comparison.html | ||
50 | 50 | ||
51 | [bencode]: https://wiki.theory.org/BitTorrentSpecification#Bencoding | 51 | [bencode]: https://wiki.theory.org/BitTorrentSpecification#Bencoding |
52 | [json-ref]: http://www.json.org/ | 52 | [json-ref]: http://www.json.org/ |
53 | [attoparsec]: http://hackage.haskell.org/package/attoparsec-0.10.4.0 | 53 | [attoparsec]: http://hackage.haskell.org/package/attoparsec-0.10.4.0 |
54 | [bytestring-builder]: http://hackage.haskell.org/packages/archive/bytestring/0.10.2.0/doc/html/Data-ByteString-Builder.html | 54 | [bytestring-builder]: http://hackage.haskell.org/packages/archive/bytestring/0.10.2.0/doc/html/Data-ByteString-Builder.html |
55 | 55 | ||
56 | [travis-img]: https://travis-ci.org/pxqr/bencoding.png | 56 | [travis-img]: https://travis-ci.org/cobit/bencoding.png |
57 | [travis-log]: https://travis-ci.org/pxqr/bencoding | 57 | [travis-log]: https://travis-ci.org/cobit/bencoding |
58 | |||
59 | [hackage]: http://hackage.haskell.org/package/bencoding | ||
60 | [issues]: https://github.com/cobit/bencoding/issues | ||
diff --git a/bencoding.cabal b/bencoding.cabal index 0aa251a..1f50c1d 100644 --- a/bencoding.cabal +++ b/bencoding.cabal | |||
@@ -1,8 +1,8 @@ | |||
1 | name: bencoding | 1 | name: bencoding |
2 | version: 0.1.0.1 | 2 | version: 0.1.0.1 |
3 | synopsis: A library for encoding and decoding of BEncode data. | 3 | synopsis: A library for encoding and decoding of BEncode data. |
4 | homepage: https://github.com/pxqr/bencoding | 4 | homepage: https://github.com/cobit/bencoding |
5 | bug-reports: https://github.com/pxqr/bencoding/issues | 5 | bug-reports: https://github.com/cobit/bencoding/issues |
6 | license: MIT | 6 | license: MIT |
7 | license-file: LICENSE | 7 | license-file: LICENSE |
8 | author: Sam T. | 8 | author: Sam T. |
@@ -25,7 +25,7 @@ extra-source-files: README.md | |||
25 | 25 | ||
26 | source-repository head | 26 | source-repository head |
27 | type: git | 27 | type: git |
28 | location: git://github.com/pxqr/bencoding.git | 28 | location: git://github.com/cobit/bencoding.git |
29 | 29 | ||
30 | 30 | ||
31 | library | 31 | library |