From 60d4779889baedc44972d4749daa073efca3b25c Mon Sep 17 00:00:00 2001 From: Stefan Majewsky Date: Mon, 19 Feb 2018 21:30:33 +0100 Subject: reorganize code * Gophercloud dependencies move into subpackage gopherschwift. * Tests move into subpackage tests (to avoid import cycles). + Rename "Client" to "Backend". --- doc.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'doc.go') diff --git a/doc.go b/doc.go index bf50a20..37ca4f3 100644 --- a/doc.go +++ b/doc.go @@ -21,6 +21,8 @@ Package schwift is a client library for OpenStack Swift (https://github.com/openstack/swift, https://openstack.org). +TODO update doc for changed auth workflow + It uses Gophercloud (https://github.com/gophercloud/gophercloud) for authentication, so you usually start by obtaining a gophercloud.ServiceClient for Swift like so: @@ -37,9 +39,9 @@ Or, if you use Swift's built-in authentication instead of Keystone: Key: "password", }) -Then, in both cases, you use schwift.AccountFromGophercloud() to obtain a -schwift.Account instance, from which point you have access to all of schwift's -API. +Then, in both cases, you use Wrap() from the subpackage gopherschwift to obtain +a schwift.Account instance, from which point you have access to all of +schwift's API. Caching -- cgit v1.2.3