From d77b247832973a8c2cb780f31ba034de45c4613f Mon Sep 17 00:00:00 2001 From: Sam T Date: Mon, 27 May 2013 04:10:31 +0400 Subject: ~ Update readme. --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b94c7967..3e8e84a5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Synopsis +### Synopsis KRPC is simple remote procedure call mechanism used by bittorrent DHT but might be used anywhere else. -# Description +### Description KRPC basically consisting of bencoded dictionaries sent over UDP. This implementation provides extra safiety by separation of procedure @@ -13,23 +13,24 @@ language, thus it's hard to shoot yourself in the foot accidently. See bittorrent DHT [specification][spec] for detailed protocol description. -## Modules +### Modules * Remote.KRPC — simple interface which reduce all RPC related stuff to a few lines. Should be used in the first place. * Remote.KRPC.Protocol — raw protocol implementation. +* Remote.KRPC.Scheme — message validation. -# Documentation +### Documentation For usage see examples in ```examples``` directory. For documentation see haddock generated documentation. -# Build Status +### Build Status [![Build Status][status-img]][status-link] -# Authors +### Maintainer This library is written and maintained by Sam T. Feel free to report bugs and suggestions via github issue tracker or the mail. -- cgit v1.2.3