From 7fb6b71a8ad5352d15c9a60136962452280917ab Mon Sep 17 00:00:00 2001 From: Tim Van Steenburgh Date: Thu, 19 May 2016 11:07:13 -0400 Subject: [PATCH] Update readme --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 35151ce..075a9ec 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ -# Getting Started +# Front Matter + +A python library for Juju. + +NOTE: There is no implementation here yet. It is simply a mocked out +design of what this library might look like. The design itself is not +complete. Comments on the design, good or bad, are welcomed. Use cases +are also appreciated as they will shape the design. + +The goal is to end up with a feature-full and officially supported +python library for Juju. + +The focus right now is on Juju 2+ only. + +# Design Ideas + +* Present an object-oriented interface to all the features of the Juju + CLI +* Do as much as possible through the API so that the library can be used + without actually installing Juju + +# Example Use Cases + +Please add more! + +## Simple bootstrap/deploy ```python from juju import Juju @@ -14,5 +39,3 @@ model.deploy('mediawiki-single') mediawiki = model.get_service('mediawiki') mediawiki.expose() ``` - - -- 2.25.1