summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSam T <pxqr.sta@gmail.com>2013-05-27 04:10:31 +0400
committerSam T <pxqr.sta@gmail.com>2013-05-27 04:10:31 +0400
commitd77b247832973a8c2cb780f31ba034de45c4613f (patch)
tree4ba2a4a86adccb9836c883255e1c30653861c814 /README.md
parentb77691e022600e7eef6f933c1d52831f732ec606 (diff)
~ Update readme.
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index b94c7967..3e8e84a5 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
1# Synopsis 1### Synopsis
2 2
3KRPC is simple remote procedure call mechanism used by bittorrent DHT 3KRPC is simple remote procedure call mechanism used by bittorrent DHT
4but might be used anywhere else. 4but might be used anywhere else.
5 5
6# Description 6### Description
7 7
8KRPC basically consisting of bencoded dictionaries sent over UDP. This 8KRPC basically consisting of bencoded dictionaries sent over UDP. This
9implementation provides extra safiety by separation of procedure 9implementation provides extra safiety by separation of procedure
@@ -13,23 +13,24 @@ language, thus it's hard to shoot yourself in the foot accidently.
13See bittorrent DHT [specification][spec] for detailed protocol 13See bittorrent DHT [specification][spec] for detailed protocol
14description. 14description.
15 15
16## Modules 16### Modules
17 17
18* Remote.KRPC — simple interface which reduce all RPC related stuff to 18* Remote.KRPC — simple interface which reduce all RPC related stuff to
19 a few lines. Should be used in the first place. 19 a few lines. Should be used in the first place.
20 20
21* Remote.KRPC.Protocol — raw protocol implementation. 21* Remote.KRPC.Protocol — raw protocol implementation.
22* Remote.KRPC.Scheme — message validation.
22 23
23# Documentation 24### Documentation
24 25
25For usage see examples in ```examples``` directory. 26For usage see examples in ```examples``` directory.
26For documentation see haddock generated documentation. 27For documentation see haddock generated documentation.
27 28
28# Build Status 29### Build Status
29 30
30[![Build Status][status-img]][status-link] 31[![Build Status][status-img]][status-link]
31 32
32# Authors 33### Maintainer
33 34
34This library is written and maintained by Sam T. <pxqr.sta@gmail.com> 35This library is written and maintained by Sam T. <pxqr.sta@gmail.com>
35Feel free to report bugs and suggestions via github issue tracker or the mail. 36Feel free to report bugs and suggestions via github issue tracker or the mail.