Files
streetmerchant/README.md
T
2020-12-13 00:23:20 -05:00

49 lines
1.8 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"
alt="streetmerchant"
/></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?query=workflow%3Aci"
><img src="https://github.com/jef/streetmerchant/workflows/ci/badge.svg"
/></a>
<a href="https://discord.gg/gbVY4vB9JF"
><img
src="https://img.shields.io/discord/773913070665859073.svg?label=chat&logo=discord&logoColor=ffffff&color=7389D8"
alt="Tweet"
/></a>
<a
href="https://twitter.com/intent/tweet?text=Beat%20the%20masses%20with%20streetmerchant&url=https://github.com/jef/streetmerchant&hashtags=typescript,opensource,bot,shopping"
><img
src="https://img.shields.io/badge/twitter-share-green?logo=twitter&style=social"
alt="Tweet"
/></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 14:
```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).