Cleanup docs, prepare v0.4.1
This commit is contained in:
parent
1336576db9
commit
4053b8454c
30
README.md
30
README.md
|
@ -5,27 +5,45 @@ 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.
|
||||
|
||||
> **HINT**: Do NOT install the GIT master, it will not work!
|
||||
|
||||
Sample Tarball installation
|
||||
---------------------------
|
||||
|
||||
```sh
|
||||
RELEASES="https://github.com/Icinga/icingaweb2-module-reactbundle/archive" \
|
||||
&& MODULES_PATH="/usr/share/icingaweb2/modules" \
|
||||
&& MODULE_VERSION=0.3.1 \
|
||||
&& MODULE_VERSION=0.4.1 \
|
||||
&& mkdir "$MODULES_PATH" \
|
||||
&& wget -q $RELEASES/v${MODULE_VERSION}.tar.gz -O - \
|
||||
| tar xfz - -C "$MODULES_PATH" --strip-components 1
|
||||
icingacli module enable reactbundle
|
||||
```
|
||||
|
||||
Sample GIT installation
|
||||
-----------------------
|
||||
|
||||
Add a new dependency
|
||||
--------------------
|
||||
```sh
|
||||
REPO="https://github.com/Icinga/icingaweb2-module-reactbundle" \
|
||||
&& MODULES_PATH="/usr/share/icingaweb2/modules" \
|
||||
&& MODULE_VERSION=0.4.1 \
|
||||
&& mkdir -p "$MODULES_PATH" \
|
||||
&& git clone ${REPO} "${MODULES_PATH}/reactbundle"
|
||||
icingacli module enable reactbundle
|
||||
```
|
||||
|
||||
|
||||
Developer Documentation
|
||||
-----------------------
|
||||
|
||||
### Add a new dependency
|
||||
|
||||
composer require author/library:version
|
||||
|
||||
Create a new release
|
||||
--------------------
|
||||
### Create a new release
|
||||
|
||||
./bin/make-release.sh <version>
|
||||
|
||||
e.g.
|
||||
|
||||
./bin/make-release.sh 0.3.1
|
||||
./bin/make-release.sh 0.1.0
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
Name: React Bundle
|
||||
Version: v0.3.1
|
||||
Version: v0.4.1
|
||||
Description: 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
|
||||
|
|
Loading…
Reference in New Issue