find-stone-beer / commit
Update README with a bit of details about the project.
README.md | 31 +++++++++++-------------------- 1 file changed, 11 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 5886983..df53141 100755 --- a/README.md +++ b/README.md @@ -1,25 +1,16 @@ -# find-stone-beer +# Find Stone Beer -Work notes on find-stone-beer +This project is a Go application that once a day pings Stone Brewing API to figure out if any of my nearby stores have Arrogant Bastard in stock, and then sends that information to my phone using Pushover. -## Pushover info +## Tech used -Application: FindStoneBeer -secret data is in gitlab +- golang +- all data comes from [Find Stone Brewing](https://find.stonebrewing.com/) web site +- Pushover is used for delivering notifications to my phone +- GitLab CICD is used to perform a scheduled run of this app +- due to Pushover 1k message limit, GitLab Pages are used to hold the entire set of results -## removed code +## So what? -```go -testSeller, err := getSellerInfo("16826826") -if err != nil { - panic(err) -} -fmt.Printf("Test seller 16826826: %v\n", testSeller) -for _, beer := range testSeller.Beers { - foundBrand, brand := findStoneInfo.FindBrandById(beer.Brand) - if !foundBrand { - panic("Could not find brand") - } - fmt.Printf("Beer: %s (%s)\n", brand.Name, beer.Brand) -} -``` +Part of the reason for this project (aside from finding where the hell Stone ships Arrogant Bastard, because they certainly don't ship it to the bigger sellers around me!) is to figure out how to perform simple tasks like this and provide notifications for myself **without needing a dedicated server**. +This project can now serve as a simple example of performing simple automation and notifying users.