diff --git a/README.md b/README.md index 061e3a5cf34b51e5a6d179e23457e71adaacde60..bd0b041779f0875fca6449738828fcb2a241d864 100644 --- a/README.md +++ b/README.md @@ -18,15 +18,15 @@ The following objects can be created and updated in your Server Density account There are plugin parameters to define how the plugin will behave: -**api_token**: An API token from Server Density to authenticate yourself -**force** (optional, defaults to False): If an object already exists whether it should be updated -**cache** (optional, defaults to None): Fully qualified filename for a cache of der Server Density data -**cleanup** (optional, defaults to False): Decides if undefined alerts in your Ansible inventory available at Server Density should be deleted -**readonly** (optional, defaults to False): If set to True it will only read the current settings from SD and stores them in a temporary file and does nothing else. This is useful when you want to find out some variable names for alerts or similar things +* **api_token**: An API token from Server Density to authenticate yourself +* **force** (optional, defaults to False): If an object already exists whether it should be updated +* **cache** (optional, defaults to None): Fully qualified filename for a cache of der Server Density data +* **cleanup** (optional, defaults to False): Decides if undefined alerts in your Ansible inventory available at Server Density should be deleted +* **readonly** (optional, defaults to False): If set to True it will only read the current settings from SD and stores them in a temporary file and does nothing else. This is useful when you want to find out some variable names for alerts or similar things ##Installation## -Download (or clone) the file serverdensity.py from the action_plugins directory and copy that into your custom action plugins directory which is defined in /etc/ansible/ansible.cfg. The default location for this is /usr/share/ansible_plugins/action_plugins +Download (or clone) the file `serverdensity.py` from the `action_plugins` directory and copy that into your custom action plugins directory which is defined in `/etc/ansible/ansible.cfg`. The default location for this is `/usr/share/ansible_plugins/action_plugins` ##Usage##