Merge ~barryprice/charm-canonical-livepatch/+git/canonical-livepatch-charm:master into ~livepatch-charmers/charm-canonical-livepatch:master

[Barry Price]

[Barry Price (barryprice)]

I believe these changes should make us compliant with the Charm store policy[1], which clears the path for us to request a charmers review[2], allowing us to promulgate to e.g. cs:canonical-livepatch

[1] https://jujucharms.com/docs/stable/authors-charm-policy
[2] https://review.jujucharms.com/reviews/new

diff --git a/README.md b/README.md
index fd273a7..4cf16a5 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,49 @@
-Overview
-========
+# Overview
 
-This subordinate charm provides live kernel updates to its unit via the Canonical Livepatch system.
+This subordinate charm provides live kernel updates to its unit via the [Canonical Livepatch Service](https://www.ubuntu.com/server/livepatch).
 
-The canonical-livepatch services are automatically installed from the Snap Store.
+The canonical-livepatch software is automatically installed from the Snap Store.
 
-You will need to supply your key from http://ubuntu.com/livepatch via juju set (1.x) or juju set-config (2.x)
+You will need to supply your key from http://ubuntu.com/livepatch via juju set (1.x) or juju config (2.x)
 
-Nagios checks are automatically deployed if you relate to an nagios-external-master service.
+Nagios checks are automatically deployed if you relate to an nagios-external-master application.
+
+# Usage
+
+This is a subordinate charn, so must be related to your primary service(s):
+
+    juju deploy canonical-livepatch
+
+    juju add-relation <your_primary_charm_name> canonical-livepatch
+
+You will need to supply your key from http://ubuntu.com/livepatch via juju set (Juju 1.x):
+
+    juju set canonical-livepatch livepatch_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+Or via juju config (Juju 2.x)
+
+    juju config canonical-livepatch livepatch_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+## Known Limitations and Issues
+
+The Nagios nrpe check integration code is a work in progress (but is fully functional)
+
+# Configuration
+
+The livepatch_key setting must be configured in order for the software to function correctly - see above.
+
+By default, the livepatch software will attempt to retrieve its patch data directly over the network. If you'd like to use an HTTPS web proxy for this traffic instead, you can set the livepatch_proxy value to the address of your proxy server.
+
+Likewise, if you need to use a proxy server to access the Snap Store, snap_proxy can also be set to the address of your proxy server.
+
+We set the Nagios servicegroups to 'livepatch' by default, this can also be reconfigured to suit your needs.
+
+# Contact Information
+
+This charm is maintained here, by the livepatch-charmers team:
+
+https://launchpad.net/canonical-livepatch-charm
+
+## Canonical Livepatch Service
+
+- https://www.ubuntu.com/server/livepatch
diff --git a/copyright b/copyright
new file mode 100644
index 0000000..1632584
--- /dev/null
+++ b/copyright
@@ -0,0 +1,17 @@
+Format: http://dep.debian.net/deps/dep5/
+
+Files: *
+Copyright: Copyright 2011, Canonical Ltd., All Rights Reserved.
+License: GPL-3
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+ .
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+ .
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.