Files
streetmerchant/README.md
T
2021-03-02 14:58:33 -05:00

33 lines
1.5 KiB
Markdown

<p align="center">
<a href="https://jef.codes/streetmerchant"><img src="https://raw.githubusercontent.com/jef/streetmerchant/main/docs/assets/images/streetmerchant-banner.png" /></a>
</p>
<p align="center">
<strong>The world's easiest, most powerful stock checker</strong>
</p>
<p align="center">
<a href="https://github.com/jef/streetmerchant/actions/workflows/ci.yaml"><img src="https://img.shields.io/github/workflow/status/jef/streetmerchant/ci?color=24292e&label=ci&logo=github&logoColor=tewt&style=flat-square" /></a>
<a href="https://discord.gg/gbVY4vB9JF"><img src="https://img.shields.io/discord/773913070665859073.svg?color=24292e&label=%20&logo=discord&logoColor=ffffff&style=flat-square" /></a>
</p>
<p align="center">
<em>To get started, visit <a href="https://jef.codes/streetmerchant">jef.codes/streetmerchant</a></em>
</p>
## Features
First and foremost, this service _will not_ automatically buy for you.
- **Checks stock continuously** -- runs 24/7, 365, looking for the items you want.
- **Ready for checkout** -- ability to add to cart when available and even opens the browser for you.
- **Notifications galore** -- when you're not by your computer, worry free with notifications to most platforms and devices when an item comes in stock.
## Quick start
streetmerchant runs on Node.js:
```shell
git clone https://github.com/jef/streetmerchant.git
cd streetmerchant && npm i && npm run start
```
For more information and customization, visit [jef.codes/streetmerchant/getting-started](https://jef.codes/streetmerchant/getting-started).