From 62c7159149a8efb3c6f8c58aad1992a95d4a53e9 Mon Sep 17 00:00:00 2001 From: Reilly Wood <26268125+rgwood@users.noreply.github.com> Date: Wed, 1 Dec 2021 21:04:41 -0500 Subject: [PATCH] Update CLI example --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 79f3633..8438836 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,16 @@ Download from [the releases page](https://github.com/rgwood/RezoningScraper/rele ``` ❯ .\RezoningScraper.exe --help RezoningScraper - A tool to detect new+modified postings on Vancouver's shapeyourcity.ca website. Data is stored in a local SQLite database next to the executable. + A tool to detect new+modified postings on Vancouver's shapeyourcity.ca website. + Data is stored in a local SQLite database next to the executable. Usage: RezoningScraper [options] Options: - --slack-webhook-url A Slack Incoming Webhook URL. If specified, RezoningScraper will post info about new+modified rezonings to this address. + --slack-webhook-url A Slack Incoming Webhook URL. If specified, RezoningScraper will post info about new+modified rezonings to this + address. + --save-to-db Whether to save the API results to database. [default: True] --version Show version information -?, -h, --help Show help and usage information ``` @@ -34,7 +37,7 @@ Public domain. Do whatever you like with this code, no attribution needed. - [ ] GitHub Actions for build+test - [ ] GitHub Action to automatically publish trimmed executables as a release -- [ ] `--dry-run` flag that doesn't update the local DB +- [x] `--dry-run` flag that doesn't update the local DB - [ ] Add retries to the token fetching. It times out fairly often - [ ] Some kind of development cache thingy. The API is slowwwww and that makes iterative development painful - [ ] Discord integration? @@ -42,5 +45,5 @@ Public domain. Do whatever you like with this code, no attribution needed. - [ ] Display more project fields? - [ ] [This is rough](https://github.com/rgwood/RezoningScraper/blob/ca38460e6ffbd177ef842b0362ff3449737bf3a5/RezoningScraper/TokenHelper.cs#L54-L60), there's gotta be a better way to query JSON - [ ] Consider archiving old versions of projects -- [ ] Strip line breaks from project titles - CoV does that sometimes and it breaks the Slack link format. +- [x] Strip line breaks from project titles - CoV does that sometimes and it breaks the Slack link format. - [x] Consider excluding `published -> archived` state transitions from Slack. Lots of noise, not particularly useful