Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
davidharrigan committed Jan 6, 2024
1 parent 94f3c10 commit 242eb19
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/imola/drivers/leclerc).

## Scrape data

Scrape driver data
Expand Down

0 comments on commit 242eb19

Please sign in to comment.