Skip to content
This repository was archived by the owner on Aug 1, 2023. It is now read-only.

Commit 57847d7

Browse files
committed
Merge pull request #282 from smashwilson/godeps
Mention setup with `godep` in the README.
2 parents b8ba1d1 + 3f2566c commit 57847d7

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,44 @@
1-
# gophercloud: the OpenStack SDK for Go
1+
# Gophercloud: the OpenStack SDK for Go
22
[![Build Status](https://travis-ci.org/rackspace/gophercloud.svg?branch=master)](https://travis-ci.org/rackspace/gophercloud)
33

4-
gophercloud is a flexible SDK that allows you to consume and work with OpenStack
4+
Gophercloud is a flexible SDK that allows you to consume and work with OpenStack
55
clouds in a simple and idiomatic way using golang. Many services are supported,
66
including Compute, Block Storage, Object Storage, Networking, and Identity.
77
Each service API is backed with getting started guides, code samples, reference
88
documentation, unit tests and acceptance tests.
99

1010
## Useful links
1111

12-
* [gophercloud homepage](http://gophercloud.io)
12+
* [Gophercloud homepage](http://gophercloud.io)
1313
* [Reference documentation](http://godoc.org/github.com/rackspace/gophercloud)
1414
* [Getting started guides](http://gophercloud.io/docs)
1515
* [Effective Go](https://golang.org/doc/effective_go.html)
1616

1717
## How to install
1818

1919
Before installing, you need to ensure that your [GOPATH environment variable](https://golang.org/doc/code.html#GOPATH)
20-
is pointing to an appropriate directory where you want to install gophercloud:
20+
is pointing to an appropriate directory where you want to install Gophercloud:
2121

2222
```bash
2323
mkdir $HOME/go
2424
export GOPATH=$HOME/go
2525
```
2626

27-
Once this is set up, you can install the gophercloud package like so:
27+
To protect yourself against changes in your dependencies, we highly recommend choosing a
28+
[dependency management solution](https://code.google.com/p/go-wiki/wiki/PackageManagementTools) for
29+
your projects, such as [godep](https://github.com/tools/godep). Once this is set up, you can install
30+
Gophercloud as a dependency like so:
2831

2932
```bash
3033
go get github.com/rackspace/gophercloud
34+
35+
# Edit your code to import relevant packages from "github.com/rackspace/gophercloud"
36+
37+
godep save ./...
3138
```
3239

33-
This will install all the source files you need into a `pkg` directory, which is
34-
referenceable from your own source files.
40+
This will install all the source files you need into a `Godeps/_workspace` directory, which is
41+
referenceable from your own source files when you use the `godep go` command.
3542

3643
## Getting started
3744

@@ -60,9 +67,9 @@ prompted for your password.
6067
### Authentication
6168

6269
Once you have access to your credentials, you can begin plugging them into
63-
gophercloud. The next step is authentication, and this is handled by a base
70+
Gophercloud. The next step is authentication, and this is handled by a base
6471
"Provider" struct. To get one, you can either pass in your credentials
65-
explicitly, or tell gophercloud to use environment variables:
72+
explicitly, or tell Gophercloud to use environment variables:
6673

6774
```go
6875
import (

0 commit comments

Comments
 (0)