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

Commit

Permalink
Merge pull request #282 from smashwilson/godeps
Browse files Browse the repository at this point in the history
Mention setup with `godep` in the README.
  • Loading branch information
jrperritt committed Oct 28, 2014
2 parents b8ba1d1 + 3f2566c commit 57847d7
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,44 @@
# gophercloud: the OpenStack SDK for Go
# Gophercloud: the OpenStack SDK for Go
[![Build Status](https://travis-ci.org/rackspace/gophercloud.svg?branch=master)](https://travis-ci.org/rackspace/gophercloud)

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

## Useful links

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

## How to install

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

```bash
mkdir $HOME/go
export GOPATH=$HOME/go
```

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

```bash
go get github.com/rackspace/gophercloud

# Edit your code to import relevant packages from "github.com/rackspace/gophercloud"

godep save ./...
```

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

## Getting started

Expand Down Expand Up @@ -60,9 +67,9 @@ prompted for your password.
### Authentication

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

```go
import (
Expand Down

0 comments on commit 57847d7

Please sign in to comment.