Update the README

This commit is contained in:
Přemysl Eric Janouch 2014-09-24 00:10:56 +02:00
parent 53b717c454
commit 9df79e3637
1 changed files with 10 additions and 0 deletions

10
README
View File

@ -11,6 +11,10 @@ of running services of a kind. It should be simple and straight-forward to
either write your own service detection plugins, provided that you're familiar
with writing asynchronous code, or to make changes to the existing ones.
So far there are some problems with reliability, and some clever algorithm to
avoid overloading the network is needed. Until then, you can use ulimit to cap
the maximum number of concurrent connections.
Building and Running
--------------------
Build dependencies: openssl, clang, pkg-config, GNU make, help2man, Jansson
@ -32,6 +36,12 @@ After making any necessary edits to the file (there are comments to aid you in
doing that), simply run the appropriate program with no arguments to retrieve
a usage text.
Author's Notes
--------------
This was quite an interesting project to write and it has taught me a lot about
event loops. It would be relatively simple to plug in libuv if more robustness
and portability is needed, though.
License
-------
`ponymap' is written by Přemysl Janouch <p.janouch@gmail.com>.