docs: set description, docs url in readme

This commit is contained in:
Lance Edgar 2025-01-06 17:34:38 -06:00
parent 6954dde8bc
commit 0171b9b1ed

View file

@ -1,8 +1,10 @@
# Sideshow # Sideshow
This is a starter project based on This is a web app which provides retailers a way to track case/special
[WuttaWeb](https://wuttaproject.org). orders.
Full docs are at https://rattailproject.org/docs/sideshow/
## Quick Start ## Quick Start
@ -13,6 +15,3 @@ Make a virtual environment and install the app:
source sideshow/bin/activate source sideshow/bin/activate
pip install Sideshow pip install Sideshow
sideshow install sideshow install
For more info see
https://rattailproject.org/docs/wuttjamaican/narr/install/index.html