From f84afe9d0b2522018938723f1357708f39853e6f Mon Sep 17 00:00:00 2001 From: Paul Battley Date: Wed, 2 May 2012 12:55:29 +0100 Subject: [PATCH] Use Markdown for README. --- README => README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) rename README => README.md (81%) diff --git a/README b/README.md similarity index 81% rename from README rename to README.md index 85438267..04171cee 100644 --- a/README +++ b/README.md @@ -1,4 +1,5 @@ -== Welcome to Panopticon +Welcome to Panopticon +===================== The GOV.UK content platform has been built with a focus on tools over content. That is manifest in the existence of numerous small applications that provide @@ -11,14 +12,13 @@ to attach consistent metadata to the pieces, connect them together as 'related items' and generally have a complete overview of all the solutions/artefacts in the system. That's this app: Panopticon. -== Interfaces +Interfaces +---------- Panopticon provides: * an admin UI where items can be created and their metadata -edited. This is authenticated in conjunction with sign-on-o-tron. - + edited. This is authenticated in conjunction with sign-on-o-tron. * a writeable API where applications can register the content -they provide. This is authenticated using HTTP Basic. - + they provide. This is authenticated using HTTP Basic. * a read API for retrieving metadata about a given item