Further cleanup

* README is now relevant
* Auth now properly skipped with os-image-url and os-auth-token provided

1 files changed, 24 insertions, 48 deletions

diff --git a/README.rst b/README.rst
index a797e17..546f6ea 100644
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,8 @@
-Python bindings to the OpenStack Glance API
+Python bindings to the OpenStack Image API
 =============================================
 
-This is a client for the OpenStack Glance API. There's a Python API (the
-``glanceclient`` module), and a command-line script (``glance``). The
-Glance 2.0 API is still a moving target, so this module will remain in
-"Beta" status until the API is finalized and fully implemented.
+This is a client for the Glance which uses the OpenStack Image API. There's a
+Python API (the ``glanceclient`` module), and a command-line script (``glance``). 
 
 Development takes place via the usual OpenStack processes as outlined in
 the `OpenStack wiki`_.  The master repository is on GitHub__.
@@ -12,10 +10,12 @@ the `OpenStack wiki`_.  The master repository is on GitHub__.
 __ http://wiki.openstack.org/HowToContribute
 __ http://github.com/openstack/python-glanceclient
 
-This code a fork of `Rackspace's python-novaclient`__ which is in turn a fork of
+This code is based on `OpenStack's python-keystoneclient`__ which is based on
+`Rackspace's python-novaclient`__ which is in turn a fork of
 `Jacobian's python-cloudservers`__. The python-glanceclient is licensed under
 the Apache License like the rest of OpenStack.
 
+__ http://github.com/openstack/python-keystoneclient
 __ http://github.com/rackspace/python-novaclient
 __ http://github.com/jacobian/python-cloudservers
 
@@ -25,11 +25,12 @@ __ http://github.com/jacobian/python-cloudservers
 Python API
 ----------
 
-By way of a quick-start::
+If you wish to use the internal python api directly, you must obtain an auth
+token and identify which endpoint you wish to speak to manually. Once you have
+done so, you can use the API::
 
-    # use v2.0 auth with http://example.com:5000/v2.0")
     >>> from glanceclient.v1 import client
-    >>> glance = client.Client(username=USERNAME, password=PASSWORD, tenant_name=TENANT, auth_url=KEYSTONE_URL)
+    >>> glance = client.Client(endpoint=OS_IMAGE_ENDPOINT, token=OS_AUTH_TOKEN)
     >>> glance.images.list()
     >>> image = glance.images.create(name="My Test Image")
     >>> print image.status
@@ -48,54 +49,29 @@ Command-line API
 ----------------
 
 Installing this package gets you a command-line tool, ``glance``, that you
-can use to interact with Glance's Identity API.
+can use to interact with Glance through the OpenStack Image API.
 
 You'll need to provide your OpenStack username, password, tenant, and auth
-endpoint. You can do this with the ``--tenant_id``, ``--username``,
-``--password``, and ``--auth_url`` params, but it's easier to just set them
+endpoint. You can do this with the ``--os-tenant-id``, ``--os-username``,
+``--os-password``, and ``--os-auth-url`` params, but it's easier to just set them
 as environment variables::
 
-    export OS_TENANT_id=
     export OS_USERNAME=user
     export OS_PASSWORD=pass
-    export OS_AUTH_URL=http://example.com:5000/v2.0
+    export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
+    export OS_AUTH_URL=http://auth.example.com:5000/v2.0
 
 Since the Identity service that Glance uses can return multiple regional image
 endpoints in the Service Catalog, you can specify the one you want with
 ``--region_name`` (or ``export OS_REGION_NAME``).
 It defaults to the first in the list returned.
 
-You'll find complete documentation on the shell by running
-``glance help``::
-
-    usage: glance [--username USERNAME] [--password PASSWORD]
-                  [--tenant_id TENANT_id]
-                  [--auth_url AUTH_URL] [--region_name REGION_NAME]
-                  <subcommand> ...
-
-    Command-line interface to the OpenStack Identity API.
-
-    Positional arguments:
-      <subcommand>
-        catalog             List all image services in service catalog
-        image-create        Create new image
-        image-delete        Delete image
-        image-list          List images
-        image-update        Update image's name and other properties
-        image-upload        Upload an image file
-        image-download      Download an image file
-        help                Display help about this program or one of its
-                            subcommands.
-
-    Optional arguments:
-      --username USERNAME   Defaults to env[OS_USERNAME]
-      --password PASSWORD   Defaults to env[OS_PASSWORD]
-      --tenant_name TENANT_NAME
-                            Defaults to env[OS_TENANT_NAME]
-      --tenant_id TENANT_ID
-                            Defaults to env[OS_TENANT_ID]
-      --auth_url AUTH_URL   Defaults to env[OS_AUTH_URL]
-      --region_name REGION_NAME
-                            Defaults to env[OS_REGION_NAME]
-
-See "glance help COMMAND" for help on a specific command.
+If you already have an auth token and endpoint, you may manually pass them
+in to skip automatic authentication with your identity service. Either define 
+them in command-line flags (``--os-image-url`` and ``--os-auth-token``) or in 
+environment variables::
+
+    export OS_IMAGE_URL=http://glance.example.org:5000/v1
+    export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
+
+You'll find complete documentation on the shell by running ``glance help``.