Merge lp:~jorge/charm-tools/new-readme-template into lp:charm-tools/1.2

[Jorge Castro]

[Marco Ceppi (marcoceppi)]

LGTM +1

review: Approve

=== modified file 'charmtools/templates/charm/README.ex'
--- charmtools/templates/charm/README.ex	2013-08-28 01:50:02 +0000
+++ charmtools/templates/charm/README.ex	2013-11-27 20:13:21 +0000
@@ -1,18 +1,16 @@
-Describe the intended usage of this charm and anything unique about how
-this charm relates to others here. 
+Describe the intended usage of this charm and anything unique about how this charm relates to others here. 
 
 This README will be displayed in the Charm Store, it should be either Markdown or RST. Ideal READMEs include instructions on how to use the charm, expected usage, and charm features that your audience might be interested in. For an example of a well written README check out Hadoop: http://jujucharms.com/charms/precise/hadoop
 
+Use this as a Markdown reference if you need help with the formatting of this README: http://askubuntu.com/editing-help
+
 Here's an example you might wish to template off of:
 
-Overview
---------
+## Overview
 
 This charm provides (service) from (service homepage). Add a description here of what the service itself actually does. 
 
-
-Usage
------
+## Usage
 
 Step by step instructions on using the charm:
 
@@ -22,20 +20,35 @@
 
 You can then browse to http://ip-address to configure the service. 
 
-Configuration
--------------
+### Scale out Usage
+
+If the charm has any recommendations for running at scale, outline them in examples here. For example if you have a memcached relation that improves performance, mention it here. 
+
+### Known Limitations and Issues
+
+This not only helps users but gives people a place to start if they want to help you add features to your charm. 
+
+## Configuration
 
 The configuration options will be listed on the charm store, however If you're making assumptions or opinionated decisions in the charm (like setting a default administrator password), you should detail that here so the user knows how to change it immediately, etc.
 
-
-Contact Information
--------------------
+## Contact Information
 
 Though this will be listed in the charm store itself don't assume a user will know that, so include that information here:
 
-Author:
-Report bugs at: http://bugs.launchpad.net/charms/+source/charmname
-Location: http://jujucharms.com/charms/distro/charmname
+### Upstream Project Name
+
+- Upstream website
+- Upstream bug tracker
+- Upstream mailing list or contact information
+
+
+### Charm Contact Information
+
+- Author: (your contact information)
+- Report bugs at: http://bugs.launchpad.net/charms/+source/charmname
+- Location: http://jujucharms.com/charms/distro/charmname
+
 
 * Be sure to remove the templated parts before submitting to https://launchpad.net/charms for inclusion in the charm store.