summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSam T <pxqr.sta@gmail.com>2013-09-26 20:58:11 +0400
committerSam T <pxqr.sta@gmail.com>2013-09-26 20:58:11 +0400
commit4756424235c5222a832e1967d54c5ddb369f6fbf (patch)
treee5683c8d3cf0fbdb04cea29d38ead37aa97a2b8f /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..83da005
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
1`base32-bytestring` is efficient [base32][rfc] codec for bytestrings.
2The API is similar to [base64-bytestring][base64-pkg] package.
3
4### Performance
5
6| function | MB/sec |
7|:---------------:|:---------------:|
8|encoding | 400 |
9|decoding | 400 |
10|lenient decoding | N/A |
11
12### Build Status [![Build Status][travis-img]][travis-log]
13
14### Maintainer <pxqr.sta@gmail.com>
15
16You can report any issues at [Issue tracker][issues].
17
18[base64-pkg]: http://hackage.haskell.org/package/base64-bytestring-1.0.0.1
19[rfc]: http://tools.ietf.org/html/rfc4648
20[travis-img]: https://travis-ci.org/cobit/base32-bytestring.png
21[travis-log]: https://travis-ci.org/cobit/base32-bytestring
22[issues]: https://github.com/cobit/base32-bytestring/issues