X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=075a9ec4dcb6c101b386e41b9dd76882933f123d;hb=40e869ca5f14b824c6ae4a7e2d23d940af25a492;hp=35151ce27c81ae604d1722e0fc213685b0d58252;hpb=3817609d3a0889b444f3cd4ffd3a72bbb21d0c9d;p=osm%2FN2VC.git 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() ``` - -