aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStefan Majewsky <majewsky@gmx.net>2018-05-03 15:14:47 +0200
committerStefan Majewsky <majewsky@gmx.net>2018-05-03 15:14:47 +0200
commit0e685c1a6632f2f421713f677dd1ae691dedaa68 (patch)
tree6e69cf8026523a63a71aa5f13f0ef87e2ab51f86 /README.md
parentaf4e8d74bfe7afd4ad65eea9d6385ca969428ed6 (diff)
downloadgo-schwift-0e685c1a6632f2f421713f677dd1ae691dedaa68.tar.gz
add configurable User-Agent to Schwift, Gopherschwift
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index b13b42b..970a6bf 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,9 @@ This is a Go client library for [OpenStack Swift](https://github.com/openstack/s
frustrated with the inflexible API design of [`ncw/swift`](https://github.com/ncw/swift); see [near the
bottom](#why-another-swift-client-library) for details.
-<p style="color:red;font-weight:bold">WARNING: This is in a pre-alpha stage and neither complete nor tested.</p>
+This library is currently in **beta**: It's already used by some projects, and I'm working towards a
+stable 1.0 version with API compatbility promises, but [a few things are still
+missing](https://github.com/majewsky/schwift/issues/1).
## Installation
@@ -29,7 +31,7 @@ authOptions, err := openstack.AuthOptionsFromEnv()
provider, err := openstack.AuthenticatedClient(authOptions)
client, err := openstack.NewObjectStorageV1(provider, gophercloud.EndpointOpts{})
-account, err := gopherschwift.Wrap(client)
+account, err := gopherschwift.Wrap(client, nil)
```
To connect to Swift using Swift's built-in authentication:
@@ -47,7 +49,7 @@ client, err := swauth.NewObjectStorageV1(provider, swauth.AuthOpts {
Key: "password",
})
-account, err := gopherschwift.Wrap(client)
+account, err := gopherschwift.Wrap(client, nil)
```
From this point, follow the [API documentation](https://godoc.org/github.com/majewsky/schwift) for what you can do with