Skip to content

Commit b616f38

Browse files
authored
Merge pull request #42 from RachelTucker/GOSDK-2
GOSDK-2: Updating documentation for release
2 parents 5171022 + 3ce4e17 commit b616f38

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,19 @@ Spectra S3 Go SDK
33

44
[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/SpectraLogic/ds3_go_sdk/blob/master/LICENSE.md)
55

6-
This is not an officially supported SDK. This was created as an experiment for a much earlier version of the
7-
Spectra S3 API. It is not compatible with the most recent version of Spectra S3.
6+
An SDK conforming to Spectra S3 for Golang 1.8
7+
8+
Contact Us
9+
----------
10+
11+
Join us at our [Google Groups](https://groups.google.com/d/forum/spectralogicds3-sdks) forum to ask questions, or see frequently asked questions.
12+
13+
14+
Contributing
15+
------------
16+
If you would like to contribute to the source code, sign the
17+
[Contributors Agreement](https://developer.spectralogic.com/contributors-agreement/). For an overview of how we use
18+
Github, please review our [Github Workflow](https://github.com/SpectraLogic/spectralogic.github.com/wiki/Github-Workflow).
819

920
Installing with GB
1021
------------------
@@ -22,6 +33,25 @@ cd ds3_go_sdk
2233
gb build all
2334
```
2435

36+
Client
37+
---------
38+
In the ds3_go_sdk you create a `Client` instance through the setting of the following environment variables and using `buildclient.FromEnv()`.
39+
40+
* `DS3_ENDPOINT` - The URL to the DS3 Endpoint
41+
* `DS3_ACCESS_KEY` - The DS3 access key
42+
* `DS3_SECRET_KEY` - The DS3 secret key
43+
* `http_proxy` - If set, the `Client` instance will proxy through this URL
44+
45+
Examples
46+
--------
47+
All examples are listed in the [samples](src/samples/) module.
48+
49+
* [How to use get service to list buckets](src/samples/getServiceSample.go)
50+
* [How to create a bucket](src/samples/getBucketSample.go)
51+
* [How to get a single object using a naked S3 get](src/samples/getObjectSample.go)
52+
* [How to use bulk put to send multiple files to the BP efficiently](src/samples/putBulkSample.go)
53+
* [How to use bulk get to retrieve multiple files from the BP efficiently](src/samples/getBulkSample.go)
54+
2555
Running Tests with GB
2656
---------------------
2757

0 commit comments

Comments
 (0)