Skip to content

Improve readme formatting #11

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

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

Improve readme formatting #11

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
18 changes: 8 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
HookServe
=========
# HookServe

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

Expand All @@ -17,30 +16,29 @@ for event := range server.Events {
}
```


###Command Line Utility

## Command Line Utility

It also comes with a command-line utility that lets you pass webhook push events to other commands.

```sh
$ hookserve --port=8888 logger -t PushEvent #log github webhook push event to the system log (/var/log/message) via the logger command
```

#####Command Line Utility Downloads
- Linux: https://phayes.github.io/bin/current/hookserve/linux/hookserve.gz
### Command Line Utility Downloads

- Linux: https://phayes.github.io/bin/current/hookserve/linux/hookserve.gz
- Mac: https://phayes.github.io/bin/current/hookserve/mac/hookserve.gz

#####Building Command Line Utility From Source
### Building Command Line Utility From Source

```bash
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
```

###Settings up GitHub Webhooks

## 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:

Expand Down