From 8d7564185f35aa8cda2f111444e735308eb9590e Mon Sep 17 00:00:00 2001 From: C <0xicl33n@gmail.com> Date: Sat, 11 Oct 2025 14:26:30 -0700 Subject: [PATCH] fancy new readme --- README.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2a14f75..e498b59 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,40 @@ # Edderkop -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 -built with +```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 +``` + + +## Tech Stack + +**Client:** micropython + +**Server:** - aiohttp - squareup - apscheduler -- aiosqlite \ No newline at end of file +- aiosqlite +