From 6c59071a6bd4b74b0f67c51dda247d2e6bbd522c Mon Sep 17 00:00:00 2001 From: David Harrigan Date: Fri, 5 Jan 2024 22:54:35 -0500 Subject: [PATCH] chore: update readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 5a58f41..9fbea8c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # formula-crunch +`formula-crunch` is an experiment with the [FastF1](https://docs.fastf1.dev/) +Python API to analyze Formula1 driver performance during a race. + +The `manage.py` Python script can scrape race data, perform analysis, and store +the result in a SQLite database. Next.js uses the SQLite database to generate +interesting graphics as static pages, so the results can be made available as a +website without any data storage dependency (although the generated graphics are +sized to be suitable for sharing on social media sites). + +See an example +[here](https://formula-cunch.vercel.app/races/2022/circuits/spa/drivers/leclerc). + ## Scrape data Scrape driver data