From 2e998b6eb0d776302172dd09005205eaeda8decb Mon Sep 17 00:00:00 2001 From: Thomas Gelf Date: Mon, 7 May 2018 18:16:18 +0200 Subject: [PATCH] README.md: add installation instructions and... ...a short updated description --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3ce6c37..9191c36 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,20 @@ -ipl 3rd Party PHP libraries -=========================== +Icinga Web 2 - ReactPHP-based 3rd party libraries +================================================= + +This repository is an attempt to ship 3rd party libraries that might be useful +for asynchronous PHP-based Icinga Web 2 modules. Please download the latest +release and install it like any other module. + +```sh +RELEASES="https://github.com/Icinga/icingaweb2-module-reactbundle/archive" \ +&& MODULES_PATH="/usr/share/icingaweb2/modules" \ +&& MODULE_VERSION=0.2.0 \ +&& mkdir "$MODULES_PATH" \ +&& wget -q $RELEASES/v${MODULE_VERSION}.tar.gz -O - \ + | tar xfz - -C "$MODULES_PATH" --strip-components 1 +icingacli module enable reactbundle +``` -This repository replicates 3rd party libraries used or suggested by the `ipl` -(Icinga PHP Library). Add a new dependency -------------------- @@ -16,5 +28,4 @@ Create a new release e.g. - ./bin/make-release.sh 0.1.0 - + ./bin/make-release.sh 0.2.0