Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
More clear installation instructions.
  • Loading branch information
jonhyman authored Jul 17, 2019
1 parent cf1437c commit e73b8ed
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,20 @@ go-pagerduty is a CLI and [go](https://golang.org/) client library for the [Page

## Installation

First, download the source code
```
go get github.com/PagerDuty/go-pagerduty
```

Next build the application.
```cli
cd $GOPATH/src/github.com/PagerDuty/go-pagerduty
go build -o $GOPATH/bin/pd command/*
# If you do not have the dependencies necessary to build the project, run this in the project root and try again
go get ./...
```

## Usage

### CLI
Expand All @@ -22,12 +32,6 @@ Example of config file:
authtoken: fooBar
```
#### Install
```cli
cd $GOPATH/github.com/PagerDuty/go-pagerduty
go build -o $GOPATH/bin/pd command/*
```

#### Commands
`pd` command provides a single entrypoint for all the API endpoints, with individual
API represented by their own sub commands. For an exhaustive list of sub-commands, try:
Expand Down

0 comments on commit e73b8ed

Please sign in to comment.