summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSam T <pxqr.sta@gmail.com>2013-08-26 22:41:18 +0400
committerSam T <pxqr.sta@gmail.com>2013-08-26 22:41:18 +0400
commit83b7014435cb6f6bd22acc3a32d095b95094fa35 (patch)
tree0a38b63d75d3ac7a6023945005c13647eec4b2fb
parentebfbff6ee74eb7d7514d0b2910e23d0cd161507f (diff)
~ Update URLs.
-rw-r--r--README.md35
-rw-r--r--bencoding.cabal6
2 files changed, 22 insertions, 19 deletions
diff --git a/README.md b/README.md
index e5ec31f..2e23741 100644
--- a/README.md
+++ b/README.md
@@ -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
4protocol but might be used anywhere else. 4protocol but might be used anywhere else.
5 5
6# Description 6### Description
7 7
8This package implements fast seamless encoding/decoding to/from 8This package implements fast seamless encoding/decoding to/from
9bencode format for many native datatypes. To achive 9bencode format for many native datatypes. To achive
10[more performance][cmp] we use [bytestring builders][bytestring-builder] 10[more performance][cmp] we use
11and hand optimized [attoparsec][attoparsec] parser so this library is 11[bytestring builders][bytestring-builder] and hand optimized
12considered as replacement for BEncode and AttoBencode packages. 12[attoparsec][attoparsec] parser so this library is considered as
13replacement for BEncode and AttoBencode packages.
13 14
14## Format 15#### Format
15 16
16Bencode is pretty similar to JSON: it has dictionaries(JSON objects), 17Bencode is pretty similar to JSON: it has dictionaries(JSON objects),
17lists(JSON arrays), strings and integers. However bencode has a few 18lists(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
36For documentation see haddock generated documentation. 37For 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
44This library is written and maintained by Sam T. <pxqr.sta@gmail.com> 45Feel free to report bugs and suggestions via [issue tracker][issues]
46or the mail.
45 47
46Feel 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 @@
1name: bencoding 1name: bencoding
2version: 0.1.0.1 2version: 0.1.0.1
3synopsis: A library for encoding and decoding of BEncode data. 3synopsis: A library for encoding and decoding of BEncode data.
4homepage: https://github.com/pxqr/bencoding 4homepage: https://github.com/cobit/bencoding
5bug-reports: https://github.com/pxqr/bencoding/issues 5bug-reports: https://github.com/cobit/bencoding/issues
6license: MIT 6license: MIT
7license-file: LICENSE 7license-file: LICENSE
8author: Sam T. 8author: Sam T.
@@ -25,7 +25,7 @@ extra-source-files: README.md
25 25
26source-repository head 26source-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
31library 31library