Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix go get path (cmd -> util), and format GitHub. #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix go get path (cmd -> util), and format GitHub. #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ HookServe

http://godoc.org/github.com/phayes/hookserve/hookserve

HookServe is a small golang utility for receiving github webhooks. It's easy to use, flexible, and provides strong security though GitHub's HMAC webhook verification scheme.
HookServe is a small golang utility for receiving GitHub webhooks. It's easy to use, flexible, and provides strong security though GitHub's HMAC webhook verification scheme.

```go
server := hookserve.NewServer()
Expand Down Expand Up @@ -36,12 +36,12 @@ $ hookserve --port=8888 logger -t PushEvent #log github webhook push event to th
sudo apt-get install golang # Download go. Alternativly build from source: https://golang.org/doc/install/source
mkdir ~/.gopath && export GOPATH=~/.gopath # Replace with desired GOPATH
export PATH=$PATH:$GOPATH/bin # For convenience, add go's bin dir to your PATH
go get github.com/phayes/hookserve/cmd/hookserve
go get github.com/phayes/hookserve/util/hookserve
```

###Settings up GitHub Webhooks


Setting up webhooks on github is easy. Navigate to `github.com/<name>/<repo>/settings/hooks` and create a new webhook. Setting up your webhook should look something like this:
Setting up webhooks on GitHub is easy. Navigate to `github.com/<name>/<repo>/settings/hooks` and create a new webhook. Setting up your webhook should look something like this:

![Configuring webhooks in github](https://i.imgur.com/u3ciUD7.png)
![Configuring webhooks in GitHub](https://i.imgur.com/u3ciUD7.png)