Skip to content

Commit b5ebe73

Browse files
committed
Touch up on the readme
1 parent fdf6fe6 commit b5ebe73

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

docs/readme.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ Here's a simple example that shows basic usage of the library. The example
4343
connects to the currently active Juju model, deploys a single unit of the
4444
ubuntu charm, then exits:
4545

46+
.. note::
47+
48+
Pylibjuju requires an already bootstrapped Juju controller to connect to.
4649

4750
.. code:: python
4851
@@ -68,9 +71,7 @@ ubuntu charm, then exits:
6871
# from the stable channel of the Charm Store.
6972
ubuntu_app = await model.deploy(
7073
'ubuntu',
71-
application_name='ubuntu',
72-
series='xenial',
73-
channel='stable',
74+
application_name='my-ubuntu',
7475
)
7576
7677
if '--wait' in sys.argv:
@@ -128,5 +129,7 @@ and then, to connect to the current model and fetch status:
128129
Versioning
129130
----------
130131

131-
Pylibjuju releases now track the Juju release cadence. New generated schemas
132+
The current Pylibjuju release policy tracks the Juju release cadence.
133+
In particular, whenever Juju makes a latest/stable release, pylibjuju pushes out
134+
a release with the same version in the following week. Newly generated schemas
132135
will be updated per Juju releases.

0 commit comments

Comments
 (0)