From d1ab927b1dcdb415660da9a6d5fa6ea64f1ef4f6 Mon Sep 17 00:00:00 2001 From: Thomas Gelf Date: Fri, 9 Nov 2018 21:42:17 +0100 Subject: [PATCH] Prepare v0.1.1, docs --- README.md | 19 ++++++++++++++++++- module.info | 6 +++--- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b89bd94..6e09298 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,33 @@ Icinga Web 2 - IPL This module ships the new Icinga PHP library. Please download the latest release and install it like any other module. +> **HINT**: Do NOT install the GIT master, it will not work! Checking out a +> branch like `stable/0.1.1` or a tag like `v0.1.1` is fine. + +Sample Tarball installation +--------------------------- + ```sh RELEASES="https://github.com/Icinga/icingaweb2-module-ipl/archive" \ && MODULES_PATH="/usr/share/icingaweb2/modules" \ -&& MODULE_VERSION=0.1.0 \ +&& MODULE_VERSION=0.1.1 \ && mkdir "$MODULES_PATH" \ && wget -q $RELEASES/v${MODULE_VERSION}.tar.gz -O - \ | tar xfz - -C "$MODULES_PATH" --strip-components 1 icingacli module enable ipl ``` +Sample GIT installation +----------------------- + +```sh +REPO="https://github.com/Icinga/icingaweb2-module-ipl" \ +&& MODULES_PATH="/usr/share/icingaweb2/modules" \ +&& MODULE_VERSION=0.1.1 \ +&& mkdir -p "$MODULES_PATH" \ +&& git clone ${REPO} "${MODULES_PATH}/ipl" +icingacli module enable ipl +``` Developer Documentation ----------------------- diff --git a/module.info b/module.info index b1f42b2..afa5f4f 100644 --- a/module.info +++ b/module.info @@ -1,5 +1,5 @@ -Name: Gipfl Bundle -Version: v0.1.0 -Description: Gipfl provides bleeding-edge libraries +Name: IPL Bundle +Version: v0.1.1 +Description: The Icinga PHP library This repository ships libraries useful for Icinga Web 2 modules. Please download the latest release and install it like any other module.