| Philip Joseph | f9c7222 | 2016-10-02 23:31:02 +0530 | [diff] [blame^] | 1 | # Overview |
| 2 | |
| 3 | Describe the intended usage of this charm and anything unique about how this |
| 4 | charm relates to others here. |
| 5 | |
| 6 | This README will be displayed in the Charm Store, it should be either Markdown |
| 7 | or RST. Ideal READMEs include instructions on how to use the charm, expected |
| 8 | usage, and charm features that your audience might be interested in. For an |
| 9 | example of a well written README check out Hadoop: |
| 10 | http://jujucharms.com/charms/precise/hadoop |
| 11 | |
| 12 | Use this as a Markdown reference if you need help with the formatting of this |
| 13 | README: http://askubuntu.com/editing-help |
| 14 | |
| 15 | This charm provides [service][]. Add a description here of what the service |
| 16 | itself actually does. |
| 17 | |
| 18 | Also remember to check the [icon guidelines][] so that your charm looks good |
| 19 | in the Juju GUI. |
| 20 | |
| 21 | # Usage |
| 22 | |
| 23 | Step by step instructions on using the charm: |
| 24 | |
| 25 | juju deploy servicename |
| 26 | |
| 27 | and so on. If you're providing a web service or something that the end user |
| 28 | needs to go to, tell them here, especially if you're deploying a service that |
| 29 | might listen to a non-default port. |
| 30 | |
| 31 | You can then browse to http://ip-address to configure the service. |
| 32 | |
| 33 | ## Scale out Usage |
| 34 | |
| 35 | If the charm has any recommendations for running at scale, outline them in |
| 36 | examples here. For example if you have a memcached relation that improves |
| 37 | performance, mention it here. |
| 38 | |
| 39 | ## Known Limitations and Issues |
| 40 | |
| 41 | This not only helps users but gives people a place to start if they want to help |
| 42 | you add features to your charm. |
| 43 | |
| 44 | # Configuration |
| 45 | |
| 46 | The configuration options will be listed on the charm store, however If you're |
| 47 | making assumptions or opinionated decisions in the charm (like setting a default |
| 48 | administrator password), you should detail that here so the user knows how to |
| 49 | change it immediately, etc. |
| 50 | |
| 51 | # Contact Information |
| 52 | |
| 53 | Though this will be listed in the charm store itself don't assume a user will |
| 54 | know that, so include that information here: |
| 55 | |
| 56 | ## Upstream Project Name |
| 57 | |
| 58 | - Upstream website |
| 59 | - Upstream bug tracker |
| 60 | - Upstream mailing list or contact information |
| 61 | - Feel free to add things if it's useful for users |
| 62 | |
| 63 | |
| 64 | [service]: http://example.com |
| 65 | [icon guidelines]: https://jujucharms.com/docs/stable/authors-charm-icon |