LICENSE and readme

1 files changed, 49 insertions, 0 deletions

diff --git a/Readme.md b/Readme.md
index 0dd576b..bf026cd 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,6 +1,55 @@
 # monitoring-custom
 
+my collection of Nagios-compatible check-plugins I use in my Icinga2 environment.
+
+## Documentation
+
+Basic documentation is provided in comments and/or as helptexts
+
+## building
+
+```
+# Building the plugins (currently not needed, bc all are scripts)
+make build
+
+# Installing
+make install
+# Install path defaults to /usr/share/monitoring-plugins. Can be set with:
+make INSTDIR=/path/to/install install
+```
+
+## using with Icinga2
+
+some plugins come with Icinga2 command configuration in `commands.conf`
+
 ```
 const CustomPluginDir = "path/to/plugins/"
 include "path/to/commands.conf"
 ```
+
+## License
+
+
+```
+MIT License
+
+Copyright (c) 2022 Jonas Gunz <himself at jonasgunz dot de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```