update readme

Author: cmeissner

README.md

@@ -1,44 +1,52 @@
-# PHPIPAM Action
+# phpIPAM Action
 
 [![CI](https://github.com/codeaffen/phpipam-action/actions/workflows/main.yml/badge.svg)](https://github.com/codeaffen/phpipam-action/actions/workflows/main.yml)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/944893481cbb43dea9335f9605c30c7e)](https://www.codacy.com/gh/codeaffen/phpipam-action/dashboard?utm_source=github.com&utm_medium=referral&utm_content=codeaffen/phpipam-action&utm_campaign=Badge_Grade)
 
-This action Spin up a PHPIPAM instance for api testing purpose in github workflows.
+This action start a complete phpIPAM instance for api testing purpose in github workflows. \
+In detail the action start two containers:
 
-## Inputs
+* a mariadb container with a phpipam database
+* a phpipam container with a phpipam installation
 
-**note** Input parameters are not used yet in our action. They are for future use. We need to work on that feature.
+After that the action does a few things to prepare the phpipam installation:
 
-### `ipam_database_host`
+* populate the database with a default data
+* activate the api
+* create a app for api connection
+* set required password change for defaut admin to _no_ - this is for local testing purposes
 
-**optional** Database host phpipam connects to. Default: "database"
+## Parameters
 
-### `ipam_database_user`
+---
+**Note:**
 
-**optional** Database user phpipam needs to authenticate. Default: "phpipam"
+There are several parameters defined in readme. These parameters were currently not used but they are here for future use.
 
-### `ipam_database_pass`
+---
 
-**optional** Database password phpipam needs to authenticate Default: "phpipam"
+The parameters are prepared as follows:
 
-### `ipam_database_name`
+* **ipam_database_host**: Database host phpipam connects to. Default: "database"
+* **ipam_database_user**: Database user phpipam needs to authenticate. Default: "phpipam"
+* **ipam_database_pass**: Database password phpipam needs to authenticate. Default: "phpipam"
+* **ipam_database_name**: Database name phpipam uses. Default: "phpipam"
+* **database_root_password**: Root password for the database. Default: "root"
 
-**optional** Database name phpipam uses. Default: "phpipam"
+## Usage
 
-### `database_root_password`
+The action is hosted in a separate repository and available on [github marketplace](https://github.com/marketplace/actions/phpipam-action){:target="_blank"}. To use it you have to add the following to your github workflow:
 
-**optional**  Root password for the database. Default: "root"
-
-## Example usage
-
-```yaml
+~~~yaml
 steps:
   - uses: actions/checkout@v2
   - uses: codeaffen/phpipam-action@v1
-    with:
-      ipam_database_host: 'database'
-      ipam_database_user: 'phpipam'
-      ipam_database_pass: 'phpipamadmin'
-      ipam_database_name: 'phpipam'
-      database_root_password: 'rootpw'
-```
+~~~
+
+If the action finishes successfully you will be able to run your api tests against the phpipam installation.
+
+~~~yaml
+- name: "Test phpipam api"
+        run: |
+          curl -k --user Admin:ipamadmin -X POST https://localhost/api/ansible/user/
+~~~