diff --git a/README.md b/README.md index c84550c..d384c9f 100644 --- a/README.md +++ b/README.md @@ -6,46 +6,75 @@ [![GitHub last commit]][commit history] [![GitHub commit activity]][commit frequency] -Summary -======= -Cli wrapper aimed as a tool to automate price harvesting from Target's redsky api. +## Summary -Want to get involved? ---------------------- -See our [contributing] doc before taking a whack at any [open issues]. We'd love for you to work with us! +Threshr is a cross-platform cli tool capable of querying product information from varying grocery stores. + +### Table of Contents + +- [Install Instructions](#install) +- [Contributing](#want-to-get-involved) + +___ + +### Roadmap + +Current store supported is Target, with Kroger, Walmart and Associated Foods on the horizon. -**Upcoming Milestones** -[![milestone 2]][milestone 2 link]
-[![milestone 7]][milestone 7 link]
-[![milestone 8]][milestone 8 link]
+#### Target -[milestone 2]:https://img.shields.io/github/milestones/progress-percent/Graqr/Threshr/2?style=plastic&label=Release%200.0.1&link=https%3A%2F%2Fgithub.com%2FGraqr%2FThreshr%2Fmilestone%2F2 +Endpoints currently supported are the `pdp_client_v1` and `product_summary_with_fulfillment_v1` endpoints. +___ +### Install -[milestone 2 link]:https://github.com/Graqr/Threshr/milestone/2 +
Windows +
    +
  1. Download latest windows binary
  2. +
  3. Move executable to dedicated directory, ie C:\Program Files\threshr\
  4. +
  5. Add directory to your PATH
  6. -[milestone 7]:https://img.shields.io/github/milestones/progress-percent/Graqr/Threshr/7?style=plastic&label=Release%200.0.2&link=https%3A%2F%2Fgithub.com%2FGraqr%2FThreshr%2Fmilestone%2F7 +```PowerShell +"C:\Program Files\threshr\" | +if (!($env:Path -like "*$_*")) +{ + $env:Path = "$( $env:Path );$_" +} +``` -[milestone 7 link]:https://github.com/Graqr/Threshr/milestone/7 +
+
-[milestone 8]:https://img.shields.io/github/milestones/progress-percent/Graqr/Threshr/8?style=plastic&label=Release%200.0.3&link=https%3A%2F%2Fgithub.com%2FGraqr%2FThreshr%2Fmilestone%2F8 +
Linux +
    +
  1. Download latest linux binary
  2. +
  3. Add to $HOME\bin\ directory
  4. +
+
-[milestone 8 link]:https://github.com/Graqr/Threshr/milestone/8 +___ -[build badge]:https://img.shields.io/github/actions/workflow/status/Graqr/Threshr/maven.yml?style=plastic&logo=github&label=Github%20CI%20with%20Maven&link=https%3A%2F%2Fgithub.com%2FGraqr%2FThreshr%2Factions"build-status" +### Want to get involved? + +See our [contributing] doc before taking a whack at any [open issues]. We'd love for you to work with us! + + +[build badge]:https://img.shields.io/github/actions/workflow/status/Graqr/Threshr/maven.yml?style=plastic&logo=github&label=Github%20CI%20with%20Maven&link=https%3A%2F%2Fgithub.com%2FGraqr%2FThreshr%2Factions%20build-status%20 [build link]:https://github.com/Graqr/Threshr/actions/workflows/maven.yml [open issues]:https://github.com/Graqr/Threshr/issues"open-issues" + [contributing]:Contributing.md -[GitHub code size in bytes]:https://img.shields.io/github/languages/code-size/Graqr/Threshr?style=plastic"project-size" +[GitHub code size in bytes]:https://img.shields.io/github/languages/code-size/Graqr/Threshr?style=plastic%20project-size%20 [download link]:https://github.com/Graqr/Threshr/archive/refs/heads/main.zip [license]:https://img.shields.io/github/license/Graqr/Threshr?style=plastic"GPL-3-License" + [license file]:LICENSE -[GitHub last commit]:https://img.shields.io/github/last-commit/Graqr/Threshr/main?style=plastic"most-recent-commit" +[GitHub last commit]:https://img.shields.io/github/last-commit/Graqr/Threshr/main?style=plastic%20most-recent-commit [commit history]:https://github.com/Graqr/Threshr/commits/main