first part of README.md

2020-11-02 14:53:18 +01:00
parent 69da6f23b6
commit c4a0b44ef5
1 changed files with 11 additions and 0 deletions
--- 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.