summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjfwood <john.wood@rackspace.com>2013-12-03 20:40:36 -0600
committerjfwood <john.wood@rackspace.com>2013-12-03 20:40:36 -0600
commita3fa50f1cb42f1d471967df9ed873af1600ea476 (patch)
tree17cb87365fda163ffd0b1eaa1b4279d02a60565e
parent0254b25ab6d5d97320031f36d1383809a81e96f5 (diff)
downloadpython-barbicanclient-a3fa50f1cb42f1d471967df9ed873af1600ea476.tar.gz
Update README.md to mention the pypi location, and to add verification information.
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index 1e4c8a8..54539fc 100644
--- a/README.md
+++ b/README.md
@@ -4,10 +4,18 @@ This is a client for the [Barbican](https://github.com/stackforge/barbican)
Key Management API. There is a Python library for accessing the API
(`barbicanclient` module), and a command-line script (`keep`).
+## Installation
+
+The client is [pip installable](https://pypi.python.org/pypi/python-barbicanclient) as follows:
+
+```bash
+pip install python-barbicanclient
+```
+
## barbicanclient - Python API
The full api is [documented in the wiki](https://github.com/cloudkeep/python-barbicanclient/wiki/Client-Usage).
-### Quickstart
+## Python Library
Store a secret in barbican using keystone for authentication:
```python
>>> from barbicanclient.common import auth
@@ -44,7 +52,7 @@ usage: keep [-h] [--no-auth | --os-auth-url <auth-url>]
Command-line interface to the Barbican API.
positional arguments:
- <entity> Entity used for command, e.g., order, secret.
+ <entity> Entity used for command, e.g., order, secret or verification.
optional arguments:
-h, --help show this help message and exit
@@ -68,7 +76,8 @@ subcommands:
<action>
create Create a new order.
store Store a secret in barbican.
- get Retrieve a secret or an order by providing its URI.
- list List secrets or orders
- delete Delete a secret or an order by providing its href.
+ verify Begin a verification process in barbican.
+ get Retrieve a secret, an order or a verification result by providing its URI.
+ list List secrets, orders or verifications.
+ delete Delete a secret, order or verification by providing its href.
```