Update README.md

README.md

@@ -14,7 +14,47 @@ This dataset contains every pitch thrown in Major League Baseball from 2015 thro
 
 This data is available through the pybaseball pacakge and the baseballr package, however it is time consuming to re scrape statcast pitch level data each time you want / need to re run your code. This dataset solves this issue using github actions to automatically update itself each week throughout the baseball season. Reading the dataset directly from the huggingface url is way faster than rescraping your data each time. 
 
-## Usage
+# Usage
+
+### With statcast_pitches package
+
+```bash
+pip install git+https://github.com/Jensen-holm/statcast-era-pitches.git
+```
+
+```python
+import statcast_pitches
+
+# get bat tracking data from 2024
+query_2024_bat_speed = f"""
+    SELECT bat_speed, swing_length
+    FROM pitches
+    WHERE 
+        YEAR(game_date) = '2024'
+        AND bat_speed IS NOT NULL;
+    """
+
+if __name__ == "__main__":
+    bat_speed_24_df = statcast_pitches.load(
+        query=query_2024_bat_speed, 
+        pandas=True, # default is polars
+    )
+
+    print(bat_speed_24_df.head(3))
+```
+
+output: 
+| | bat_speed  | swing_length |
+|-|------------|--------------|
+| 0 | 73.61710 | 6.92448 |
+| 1 | 58.63812 | 7.56904 |
+| 2 | 71.71226 | 6.46088 |
+
+**Notes**:
+- If no query is specified, all data from 2015-present will be loaded into a DataFrame.
+- The table in your query MUST be called 'pitches', or it will fail.
+
+### With HuggingFace API
 
 ***Pandas***
 
@@ -24,13 +64,6 @@ import pandas as pd
 df = pd.read_parquet("hf://datasets/Jensen-holm/statcast-era-pitches/data/statcast_era_pitches.parquet")
 ```
 
-***Duckdb***
-
-```sql
-SELECT *
-FROM 'hf://datasets/Jensen-holm/statcast-era-pitches/data/statcast_era_pitches.parquet';
-```
-
 ***Polars***
 
 ```python
@@ -39,6 +72,13 @@ import polars as pl
 df = pl.read_parquet('hf://datasets/Jensen-holm/statcast-era-pitches/data/statcast_era_pitches.parquet')
 ```
 
+***Duckdb***
+
+```sql
+SELECT *
+FROM 'hf://datasets/Jensen-holm/statcast-era-pitches/data/statcast_era_pitches.parquet';
+```
+
 ***HuggingFace Dataset***
 
 ```python
@@ -56,13 +96,7 @@ statcast_pitches <- read_parquet(
 )
 ```
 
-## Variable Docs
-
-Documentation on the columns/features in this dataset can be found [here](https://baseballsavant.mlb.com/csv-docs).
-
-## Updates
-
-This data set is updated once per week through GitHub Actions in [this repository](https://github.com/Jensen-holm/statcast-era-pitches). the [pybaseball](https://github.com/jldbc/pybaseball) package is used to retrieve new statcast pitch level data each monday morning at 12:00 PM ET. It is then pushed to this huggingface dataset.  
+see the [dataset](https://huggingface.co/datasets/Jensen-holm/statcast-era-pitches) on HugingFace itself for more details. 
 
 ## Benchmarking
 
@@ -72,5 +106,5 @@ This data set is updated once per week through GitHub Actions in [this repositor
 |---------------|-----|
 | 1421.103 | pybaseball |
 | 26.899 | polars |
-| 33.09332203865051 | pandas |
-| 68.69287300109863	| duckdb |
+| 33.093 | pandas |
+| 68.692	| duckdb |