mirror of
https://github.com/opelly27/streetmerchant.git
synced 2026-05-20 02:57:34 +00:00
feat(docs): add mkdocs
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
[](https://jef.codes/streetmerchant)
|
||||
|
||||
## 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.
|
||||
|
||||
## Getting started
|
||||
|
||||
You'll find most of the content on the left sidebar. The right sidebar will help you navigate a page.
|
||||
|
||||
### Contributing
|
||||
|
||||
- Give helpful tips and tricks to the [community based wiki](https://github.com/jef/streetmerchant/wiki).
|
||||
- Add to the documentation through [pull requests](https://github.com/jef/streetmerchant/pulls).
|
||||
- Fork and make a pull request to the repository.
|
||||
|
||||
### Looking for help
|
||||
|
||||
- File a [GitHub issue](https://github.com/jef/streetmerchant/issues/new/choose).
|
||||
- Join us on [Discord](https://discord.gg/gbVY4vB9JF).
|
||||
|
||||
### Supporting the project
|
||||
|
||||
The best way to support me is to donate to [Diabetes Research Institute](https://www.diabetesresearch.org/Give).
|
||||
|
||||
> The Diabetes Research Institute leads the world in cure-focused diabetes research.
|
||||
>
|
||||
> [diabetesresearch.org](https://www.diabetesresearch.org/about-DRI)
|
||||
|
||||
If you feel inclined to support me directly, here are those options:
|
||||
|
||||
- [GitHub Sponsors](https://github.com/sponsors/jef)
|
||||
- [Paypal](https://www.paypal.me/jxf)
|
||||
Reference in New Issue
Block a user