diff --git a/README.md b/README.md index db9ee4d..bd5167c 100644 --- a/README.md +++ b/README.md @@ -1 +1,12 @@ # pyinotifyd +A daemon to monitore filesystems events with inotify on Linux and execute tasks, which can be Python functions or shell commands. + +## Dependencies +[pyinotify](https://github.com/seb-m/pyinotify) + +## Installation +* Install pyinotifyd with pip. +```sh +pip install pyinotifyd +``` +* Modify /etc/pyinotifyd/config.py according to your needs.