Skip to content

Commit

Permalink
README: Remove reference to godep
Browse files Browse the repository at this point in the history
For the better or for the worse, the Go ecosystem has now migrated to
using modules.
  • Loading branch information
pierreprinetti committed Oct 27, 2021
1 parent ecbce89 commit f9603bb
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,18 @@ Gophercloud is an OpenStack Go SDK.

## 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:
Reference a Gophercloud package in your code:

```bash
mkdir $HOME/go
export GOPATH=$HOME/go
```Go
import "github.com/gophercloud/gophercloud"
```

To protect yourself against changes in your dependencies, we highly recommend choosing a
[dependency management solution](https://github.com/golang/go/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:
Then update your `go.mod`:

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

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

godep save ./...
```shell
go mod tidy
```

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

### Credentials
Expand Down

0 comments on commit f9603bb

Please sign in to comment.