knights-special/README.md
2017-01-09 17:20:06 -05:00

22 lines
597 B
Markdown

# Knight's Daily Special Scraper
Who doesn't love [Knight's](http://www.knightsrestaurants.com/)? Their steak sandwich lunch special is delicious.
So here is a simple HTML scraper to get Knight's current specials for their various locations in a very interceptable way (JSON, pretty JSON, or just CLI output).
## Installation
### Requirements
* Go version >= 1.5
* GOPATH set in your ENV
* (optional, but recommended) `$GOPATH/bin` in `$PATH`
```bash
go get -u github.com/tblyler/knights-special
```
## Documentation
Run the following after installation...
```bash
knights-special --help
```