Merge ~mthaddon/ubuntu-mirror-charm/+git/ubuntu-mirror-charm:readme-markdon into ubuntu-mirror-charm:master

[Tom Haddon]

Rename README to include file extension for rendering on charmhub, some formatting updates, and juju config vs. juju set

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

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

[Romain Couturat (romaincout)]

lgtm

review: Approve

[Barry Price (barryprice)]

LGTM +1

review: Approve

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

Change successfully merged at revision deff9500f3af2e12e089278b960d8f51ac1d2e72

diff --git a/README b/README.md
similarity index 63%
rename from README
rename to README.md
index 3d96b98..1687979 100644
--- a/README
+++ b/README.md
@@ -17,9 +17,9 @@ be deployed using:
 Once deployed, you will need to configure it for your local environment.
 An Ubuntu archive mirror can be created using the following commands:
 
-    juju set ubuntu-mirror mirror_ubuntu_name="myhost.mydomain.com"
-    juju set ubuntu-mirror mirror_ubuntu_sync_time="0 1 * * *"
-    juju set ubuntu-mirror role_map='{"myhost":["ubuntu"]}'
+    juju config ubuntu-mirror mirror_ubuntu_name="myhost.mydomain.com"
+    juju config ubuntu-mirror mirror_ubuntu_sync_time="0 1 * * *"
+    juju config ubuntu-mirror role_map='{"myhost":["ubuntu"]}'
 
 Replace "myhost" with the hostname of your server and "myhost.mydomain.com" with
 its fully qualified domain name (FQDN).
@@ -29,34 +29,35 @@ The "role_map" variable tells the charm what type of mirror you want to create
 "releases" (a mirror of releases.ubuntu.com), "cdimage" (a mirror of
 cdimage.ubuntu.com" or "ports" (a mirror of ports.ubuntu.com)  If you have a
 sufficiently large server, multiple roles can be assigned to one server
-(role_map='{"myhost":["ubuntu","cdimage"]}' for example)
+(`role_map='{"myhost":["ubuntu","cdimage"]}'` for example).
 
-If you have more than one server, you should list each one (e.g. role_map='{"host1":["cdimage","ubuntu"],"host2":["releases"]}')
+If you have more than one server, you should list each one (e.g. `role_map='{"host1":["cdimage","ubuntu"],"host2":["releases"]}'`).
 
 The "mirror_ubuntu_name" variable is the name the webserver will use for
 the Ubuntu mirror.  In the above example, it would answer requests for
-http://myhost.mydomain.com
+`http://myhost.mydomain.com`.
 
 The "mirror_ubuntu_sync_time" variable tells the charm what time it should
 update.  In the above example, the update would happen every day at 1am.
 
 There are a number of variables that can be set on a per-role basis.  They
-all follow the pattern mirror_<rolename>_<variable>, so if we were setting up
+all follow the pattern `mirror_<rolename>_<variable>`, so if we were setting up
 a cdimage mirror, we would use "mirror_cdimage_name" and
 "mirror_cdimage_sync_time".
 
 To cater for rsync servers that require authentication, there is a per-role
-variable, mirror_<rolename>_rsync_auth.  If you don't need to authenticate
+variable, `mirror_<rolename>_rsync_auth`.  If you don't need to authenticate
 against your upstream mirror, leave this alone, the defaults will be fine.
 If you do need to authenticate, this variable should be used like this:
 
-    juju set ubuntu-mirror mirror_cdimage_rsync_auth='{"myhost":{"user":"eric", "password":"YXBwbGVzCg=="}}'
+    juju config ubuntu-mirror mirror_cdimage_rsync_auth='{"myhost":{"user":"eric", "password":"YXBwbGVzCg=="}}'
 
-The password value is just a Base64-encoded string, just in case it needs to contain any special characters (it also helps avoid people casually reading passwords over your shoulder when you run juju get).
+The password value is just a Base64-encoded string, just in case it needs to
+contain any special characters (it also helps avoid people casually reading
+passwords over your shoulder when you run `juju config`).
 
 As with role_map (above), if you have multiple servers they should all be listed
-(e.g. mirror_cdimage_rsync_auth='{"host1":{"user":"eric","password":"YXBwbGVzCg=="},"host2":{"user":"frank","password":"b3Jhbmdlcwo="}}')
+(e.g. `mirror_cdimage_rsync_auth='{"host1":{"user":"eric","password":"YXBwbGVzCg=="},"host2":{"user":"frank","password":"b3Jhbmdlcwo="}}'`).
 
 For simplicity, if all of your servers authenticate with the same username
-and password, you can use: '{"<<all>>":{"user":"eric","password":"YXBwbGVzCg=="}}'.
-
+and password, you can use: `{"<<all>>":{"user":"eric","password":"YXBwbGVzCg=="}}`.