X-Git-Url: https://git.kaliko.me/?p=python-daemon.git;a=blobdiff_plain;f=doc%2FREADME;fp=doc%2FREADME;h=66562152aca92ebc72cb7d47000b72f6a107e344;hp=0000000000000000000000000000000000000000;hb=43f9a47ada69104b79a759a56ff6706945503ec2;hpb=541ee94a0a5ae51b7c2d6995a78e6cf86ec9ec25

diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..6656215
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,16 @@
+python-daemon is a pretty simple object named Daemon used to daemonize a process.
+
+To do so subclass the Daemon object and override its run method with the code
+you want to turn into a unix daemon.
+
+You can override the shutdown method which is called on Daemon stop (either via
+the stop method or on SIGTERM).
+
+Cf. examples for code snippet.
+
+
+FEATURES:
+	* redirects stderr|stdout to file
+	* writes a pid file
+	* transparently deletes the pid file at stop
+	* catch SIGTERM and handles a clean stop via shutdown method