diff --git a/.gitignore b/.gitignore index 25747e8..a82ba2c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ execNotifyDir/config/cfg.ini -__pycache__/ \ No newline at end of file +__pycache__/ +.idea/workspace.xml \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml deleted file mode 100644 index c0c35d8..0000000 --- a/.idea/workspace.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1607247615238 - - - 1607257112486 - - - 1607257255152 - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..b6e94ac --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# execNotify + +## setup + +Create a `config.ini` file inside `execNotifyDir/config`. + +For the required fields, see `execNotifyDir/config/config.ini.example` + +## installation + +```shell +sudo make install +``` + +## usage + +Add `execNotify` in front of your command to execute. + +You can pipe into `execNotify` but **not** from `execNotify + as the output gets modified. + +### Example + +For `ls /home` run `execNotify ls /home`