diff options
author | Sam T <pxqr.sta@gmail.com> | 2013-05-14 10:45:40 +0400 |
---|---|---|
committer | Sam T <pxqr.sta@gmail.com> | 2013-05-14 10:45:40 +0400 |
commit | 7c18b3fb5077c43aca7b728649108fda901ba236 (patch) | |
tree | 6438a16dbf3bc3b461c0a5bd935c10988537313c /README.md | |
parent | ab6ad1b5a10c46908a2c53a8148f5d202e517c7a (diff) |
+ Added readme.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..bf9a28de --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,39 @@ | |||
1 | # Synopsis | ||
2 | |||
3 | KRPC is simple remote procedure call mechanism used by bittorrent DHT | ||
4 | but might be used anywhere else. | ||
5 | |||
6 | # Description | ||
7 | |||
8 | KRPC basically consisting of bencoded dictionraies sent over UDP. This | ||
9 | implementation provides extra safiety by separation of procedure | ||
10 | signature | implementation and baking procedure type in host | ||
11 | language, thus it's hard to shoot yourself in the foot accidently. | ||
12 | |||
13 | See bittorrent DHT [specification][spec] for detailed protocol | ||
14 | description. | ||
15 | |||
16 | ## Modules | ||
17 | |||
18 | * Remote.KRPC — simple interface which reduce all RPC related stuff to | ||
19 | a few lines. Should be used in the first place. | ||
20 | |||
21 | * Remote.KRPC.Protocol — raw protocol implementation. | ||
22 | |||
23 | # Documentation | ||
24 | |||
25 | For usage see examples in ```examples``` directory. | ||
26 | For documentation see haddock generated documentation. | ||
27 | |||
28 | # Build Status | ||
29 | |||
30 | [![Build Status][status-img]][status-link] | ||
31 | |||
32 | # Authors | ||
33 | |||
34 | This library is written and maintained by Sam T. <pxqr.sta@gmail.com> | ||
35 | Feel free to report bugs and suggestions via github issue tracker or the mail. | ||
36 | |||
37 | [spec]: http://www.bittorrent.org/beps/bep_0005.html#krpc-protocol | ||
38 | [status-img]: https://travis-ci.org/pxqr/krpc.png | ||
39 | [status-link]: https://travis-ci.org/pxqr/krpc | ||