Started documentation. See #1.

UKHomeOffice · May 11, 2017 · 6fe0833 · 6fe0833
1 parent bafd644
commit 6fe0833
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,26 @@
 # keycloak-theme-govuk
-A Keycloak theme using GOV.UK Template and Elements
+
+A Keycloak theme using GOV.UK Template and Elements.
+
+
+## How to use
+
+This theme has been deployed to the UK Home Office hosting platform Keycloak Docker container. To use it on your Keycloak realm:
+
+1. Sign into your realm's admin console.
+
+![](docs/images/use-1.png)
+
+2. Go to the “Themes” tab in “Realm Settings”
+
+![](docs/images/use-2.png)
+
+3. Select “govuk_latest” as your login theme, and click on “Save”
+
+![](docs/images/use-3.png)
+
+The theme will now be used for all Keycloak log in screens on your realm - including logging in to the admin console. If you sign out, you should see the GOV.UK themed log in screen.
+
+![](docs/images/use-4.png)
+
+
diff --git a/docs/images/use-1.png b/docs/images/use-1.png
diff --git a/docs/images/use-2.png b/docs/images/use-2.png
diff --git a/docs/images/use-3.png b/docs/images/use-3.png
diff --git a/docs/images/use-4.png b/docs/images/use-4.png