Skip to content

Commit

Permalink
Doc updates (#131)
Browse files Browse the repository at this point in the history
Change README to RST for PyPI and indicate that docs have moved to RTD

Fixes #27
  • Loading branch information
johnsca committed Mar 15, 2018
1 parent 40ee905 commit 87680c9
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
2 changes: 1 addition & 1 deletion MANIFEST.in
Expand Up @@ -3,5 +3,5 @@ include Makefile
include VERSION
include MANIFEST.in
include scripts/*
include README.md
include README.rst
recursive-include debian *
20 changes: 15 additions & 5 deletions README.md → README.rst
@@ -1,10 +1,18 @@
# CharmHelpers
CharmHelpers |badge|
--------------------

## Overview
.. |badge| image:: https://travis-ci.org/juju/charm-helpers.svg?branch=master
:target: https://travis-ci.org/juju/charm-helpers

Overview
========

CharmHelpers provides an opinionated set of tools for building Juju charms.

## Common Usage Examples
The full documentation is available online at: https://charm-helpers.readthedocs.io/

Common Usage Examples
=====================

* interaction with charm-specific Juju unit agents via hook tools;
* processing of events and execution of decorated functions based on event names;
Expand All @@ -15,14 +23,16 @@ CharmHelpers provides an opinionated set of tools for building Juju charms.
* retrieval of machine-specific details;
* implementation of application-specific code reused in similar charms.

## Why Python?
Why Python?
===========

* Python is an extremely popular, easy to learn, and powerful language which is also common in automation tools;
* An interpreted language helps with charm portability across different CPU architectures;
* Doesn't require debugging symbols (just use pdb in-place);
* An author or a user is able to make debugging changes without recompiling a charm.

## License
License
=======

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -43,7 +43,7 @@
"bin/contrib/saltstack/salt-call",
],
'license': "Apache 2.0 (ASL)",
'long_description': open('README.md').read(),
'long_description': open('README.rst').read(),
'description': 'Helpers for Juju Charm development',
}

Expand Down

0 comments on commit 87680c9

Please sign in to comment.