diff --git a/README.md b/README.md index dfd8f32..5f7932e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,40 @@ # Studspider -environment: poetry +is a tool used to talk to brickset.com and a square inventory to pull lego set information for entering in the square db +## Run Locally -code style: black +Clone the project + +```bash + git clone http://git.traps.moe/ph0sgene/edderkop.git +``` + +Go to the project directory + +```bash + cd cd edderkop +``` + +Install dependencies + +```bash + uv sync && uv lock +``` + +Start the server + +```bash + uvx run edderkop.py +``` -built with +## Tech Stack +**Client:** micropython + +**Server:** - aiohttp - squareup - apscheduler -- aiosqlite \ No newline at end of file +- aiosqlite +