robin/notify-redis
1
0
Fork 0
mirror of https://github.com/icewind1991/notify-redis.git synced 2026-06-03 18:24:12 +02:00
Code Issues Projects Releases Wiki Activity

extend readme

Browse source
This commit is contained in:
Robin Appelman 2018-04-17 13:43:13 +02:00
commit 77be5f9dff
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -8,4 +8,11 @@ Push filesystem notifications into a redis list
notify-redis /path/to/watch redis://localhost list_name
```
The recorded filesystem events will be pushed to the configured list.
The events are encoded in the following ways
- `write|$path`
- `remame|$from|$to`
- `remove|$path`
Filesystem events are debounced and merge where applicable (e.g. `touch foo.txt`, `mv foo.txt bar.txt` will result in one write event for `bar.txt`)