Some cleanup and documentation

[python-daemon.git] / doc / README

diff --git a/doc/README b/doc/README
new file mode 100644 (file)
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