X-Git-Url: http://git.kaliko.me/?p=python-daemon.git;a=blobdiff_plain;f=README;fp=README;h=03e74c71930f08293cfc0b1f2bcf8bff2c748112;hp=0000000000000000000000000000000000000000;hb=ca0b30b5ae63177c6c27a51e066c0cd6641e8c0c;hpb=ede0547a2e4ffbfa7670ecabd507dd892b6b0b85

diff --git a/README b/README
new file mode 100644
index 0000000..03e74c7
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+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
+
+UPSTREAM:
+    Code maintained at http://git.kaliko.me/?p=python-daemon.git
+    Please send feedback at <kaliko@azylum.org>