Permalink
Browse files

add usage in readme

  • Loading branch information...
1 parent 6028be3 commit cec12663f15f0a54b0354c4a8062ae5f2956146a @lemanyk committed Dec 26, 2012
Showing with 30 additions and 1 deletion.
  1. +30 −1 README.md
View
@@ -1,4 +1,33 @@
logger
======
-logging server written on gevent
+logging server written on gevent
+
+
+Run log server:
+---------------
+```
+from netlog import Server
+Server('./logs', 5010).start()
+```
+
+
+Usage from clients:
+-------------------
+```
+from netlog import Client
+client = Client('127.0.0.1', 5010, 'logname')
+client.send('qwe asd')
+client.send('ert \n dfg') # may be multiline
+client.close() # or del client
+```
+
+
+Features:
+---------
+
+- put to one log file from many client processes
+- save in binary format .tar.gz, use zcat and zgrep and for read
+- unlimited size of log string
+- rotation by date
+- automatic delete old logs

0 comments on commit cec1266

Please sign in to comment.