Skip to content

Commit

Permalink
refactor(docs): remove cli aspect from readme
Browse files Browse the repository at this point in the history
Signed-off-by: Jonathan Zollinger <jonathan.zollinger@gmail.com>
  • Loading branch information
Jonathan-Zollinger committed Jan 21, 2024
1 parent f80c359 commit 6d98da0
Showing 1 changed file with 8 additions and 35 deletions.
43 changes: 8 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,48 +8,21 @@

## Summary

Threshr is a cross-platform cli tool capable of querying product information from varying grocery stores.
Threshr is java library wrappper capable of querying product information from varying Target's various api's, aimed
at querying product pricing.

### Table of Contents

- [Install Instructions](#install)
- [Contributing](#want-to-get-involved)
### Usage

___
see tests for [examples](https://github.com/Graqr/Threshr/blob/e643e9a7bde831d73587da0e55ae8799a9b79ee2/src/test/groovy/com/graqr/threshr).

### Roadmap

Current store supported is Target, with Kroger, Walmart and Associated Foods on the horizon.

#### Target
I want to facilitate querying prices with these improvements:
- something easier than including target store ID's when specifying target store locations
- flesh out target's department & category information
- flesh out products which can be queried

Endpoints currently supported are the `pdp_client_v1` and `product_summary_with_fulfillment_v1` endpoints.
___
### Install

<details><summary>Windows</summary>
<ol>
<li>Download latest windows <a href="https://github.com/Graqr/Threshr/releases/latest">binary</a></li>
<li>Move executable to dedicated directory, ie <code>C:\Program Files\threshr\</code></li>
<li>Add directory to your PATH</li>

```PowerShell
"C:\Program Files\threshr\" |
if (!($env:Path -like "*$_*"))
{
$env:Path = "$( $env:Path );$_"
}
```

</ol>
</details>

<details><summary>Linux</summary>
<ol>
<li>Download latest linux <a href="https://github.com/Graqr/Threshr/releases/latest">binary</a></li>
<li>Add to <code>$HOME\bin\</code> directory</li>
</ol>
</details>

___

Expand Down

0 comments on commit 6d98da0

Please sign in to comment.