From 4caefbba49a5675d39fa87f26a757f8131313598 Mon Sep 17 00:00:00 2001 From: Stefan Majewsky Date: Fri, 28 May 2021 13:53:57 +0200 Subject: doc: extend usage example --- README.md | 6 +++++- doc.go | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 00767a0..44d7387 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,11 @@ 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 -the `schwift.Account` object. +the `schwift.Account` object. For example, to download an object's contents into a string: + +``` +text, err := account.Container("foo").Object("bar.txt").Download(nil).AsString() +``` ## Why another Swift client library? diff --git a/doc.go b/doc.go index 1d0dca5..e4e7809 100644 --- a/doc.go +++ b/doc.go @@ -58,6 +58,10 @@ have access to all of schwift's API: account, err := gopherschwift.Wrap(client) +For example, to download an object's contents into a string: + + text, err := account.Container("foo").Object("bar.txt").Download(nil).AsString() + Authentication with a different OpenStack library If you use a different Go library to handle Keystone/Swift authentication, take -- cgit v1.2.3