WIP: linter setup

README.md

@@ -1,35 +1,43 @@
-# TRMNL Weather & Pollen Report
+# trmnl weather & pollen report
 
-A custom TRMNL plugin that fetches and displays weather and pollen data.
+a custom trmnl plugin that fetches and displays weather and pollen data.
 
-## Setup
+## setup
 
-1. Set up a virtual environment and install dependencies:
+1. set up a virtual environment and install dependencies:
    ```bash
    python -m venv .venv
    source .venv/bin/activate
    uv sync
    ```
 
-2. Set required environment variables:
+2. set required environment variables:
    ```bash
    export WEATHER_API_KEY="your_openweathermap_api_key"
    export AUTH_TOKEN="your_chosen_auth_token"
    ```
 
-3. Run the application:
+3. run the application:
    ```bash
    fastapi run main.py --port 8887
    ```
 
-## Docker
+## development
 
-Build and run with Docker:
+### install development dependencies
+
+```bash
+make dev-install
+```
+
+## docker
+
+build and run with docker:
 ```bash
 docker build -t trmnl-report .
 docker run -p 8887:8887 -e WEATHER_API_KEY=your_key -e AUTH_TOKEN=your_token trmnl-report
 ```
 
-## API
+## api
 
-Access the API at `http://localhost:8887/?token=your_auth_token`
+access the api at `http://localhost:8887/?token=your_auth_token`