Merge ~mthaddon/charm-k8s-unifi-poller/+git/charm-k8s-unifi-poller:usage-readme into charm-k8s-unifi-poller:master

[Tom Haddon]

Update README to favour deployment from the charmstore with default image

Update README to favour deployment from the charmstore with default image

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Gareth Woolridge (moon127)]

LGTM

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision f9ba43511ba563c4652b1ad89989c92663415a75

diff --git a/README.md b/README.md
index e42a63b..15fc889 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,37 @@ See [Unifi Poller github page](https://github.com/unifi-poller/unifi-poller) and
 
 ## Usage
 
-For config options see descriptions in config.yaml.
+To deploy into a k8s model:
+
+    juju deploy cs:~unifi-poller-charmers/unifi-poller
+
+The charm will not function without connection details for a Unifi Network Controller.  You will need to create a read-only admin user on the controller with access to all sites by following [prerequisite steps from the wiki](https://github.com/unifi-poller/unifi-poller/wiki/Installation#prerequisites), then:
+ 
+    juju config unifi_poller controller_url="https://<ip_address>:8443"
+    juju config unifi_poller controller_username=unifipoller
+    juju config unifi_poller controller_password=unifipoller
+
+Optionally we can also enable DPI (Deep Packet Inspection) data collection from the Controller.  To utilise this there must be at least one site using a Unifi Security Gateway product such as the USG or UDM devices or their Pro variants, and such a site must also have DPI enabled in site configuration, then:
+
+    juju config unifi_poller controller_dpi=true
+
+Configuring the controller URL, and credentials is sufficient config to configure polling and to enable the prometheus endpoint on http://<pod/cluster_IP>:9130/metrics
+
+To expose that endpoint outside the k8s cluster via the ingress e.g.:
+ 
+    juju config unifi-poller juju-external-hostname="unifi-poller.example.domain"
+    juju expose unifi-poller
+
+This will expose the service via the kubernetes nginx ingress via a virtual host, e.g. http://unifi-poller.example.com/metrics
+
+The charm optionally supports an externally deployed InfluxDB instance which may be preferred for longer term data storage.  This could be deployed outside the cluster in a suitable juju model using juju deploy cs:influxdb.  The Unifi Poller charm supports authentication to the InfluxDB instance, if required:
+
+    juju config unifi-poller influxdb_url="https://<ip_address>:8086"
+    juju config unifi-poller influxdb_dbname=unifi
+    juju config unifi-poller influxdb_username=unifipoller
+    juju config unifi=poller influxdb_password=unifipoller
+
+## Local Development
 
 Notes for deploying a test setup locally using microk8s:
 
@@ -39,32 +69,6 @@ Notes for deploying a test setup locally using microk8s:
     juju wait
     juju status
 
-The charm will not function without connection details for a Unifi Network Controller.  You will need to create a read-only admin user on the controller with access to all sites by following [prerequisite steps from the wiki](https://github.com/unifi-poller/unifi-poller/wiki/Installation#prerequisites), then:
- 
-    juju config unifi_poller controller_url="https://<ip_address>:8443"
-    juju config unifi_poller controller_username=unifipoller
-    juju config unifi_poller controller_password=unifipoller
-
-Optionally we can also enable DPI (Deep Packet Inspection) data collection from the Controller.  To utilise this there must be at least one site using a Unifi Security Gateway product such as the USG or UDM devices or their Pro variants, and such a site must also have DPI enabled in site configuration, then:
-
-    juju config unifi_poller controller_dpi=true
-
-Configuring the controller URL, and credentials is sufficient config to configure polling and to enable the prometheus endpoint on http://<pod/cluster_IP>:9130/metrics
-
-To expose that endpoint outside the k8s cluster via the ingress eg:
- 
-    juju config unifi-poller juju-external-hostname="unifi-poller.example.domain"
-    juju expose unifi-poller
-
-This will expose the service via the kubernetes nginx ingress via a virtual host, eg http://unifi-poller.example.com/metrics
-
-The charm optionally supports an externally deployed InfluxDB instance which may be preferred for longer term data storage.  This could be deployed outside the cluster in a suitable juju model using juju deploy cs:influxdb.  The Unifi Poller charm supports authentication to the InfluxDB instance, if required:
-
-    juju config unifi-poller influxdb_url="https://<ip_address>:8086"
-    juju config unifi-poller influxdb_dbname=unifi
-    juju config unifi-poller influxdb_username=unifipoller
-    juju config unifi=poller influxdb_password=unifipoller
-
 ### Additional Controllers / Config Options
 
 The Unifi Poller charm supports configuring additional controllers and additional options,  which can be added via the extra_configs charm option.