Merge ~aieri/juju-lint:improve_readme into juju-lint:master

[Andrea Ieri]

Improve the README by adding a full example

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

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

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

Unable to determine commit message from repository - please click "Set commit message" and enter the commit message manually.

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

Change successfully merged at revision 2eeb194be8cf884214b0f2cabc156a6745362ecb

diff --git a/README.md b/README.md
index faa3ef6..9058da9 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,17 @@ To use a different rules file:
 
 For all other options, consult `juju-lint --help`
 
+== Example ==
+
+A typical use case is linting an openstack cloud:
+
+    juju status -m openstack --format=json > juju-status.json
+    juju export-bundle --include-charm-defaults -m openstack > bundle.yaml
+    juju-lint -c /snap/juju-lint/current/contrib/openstack-focal-ovn.yaml \
+        -t openstack juju-status.json
+    juju-lint -c /snap/juju-lint/current/contrib/openstack-focal-ovn.yaml \
+        -t openstack bundle.yaml
+
 == Rules File ==
 
 For an example of a rules file, see `example-lint-rules.yaml`.