From 52db9b8131abb7a75ccb365ad8d1d4f9fc43277e Mon Sep 17 00:00:00 2001
From: Luke Hagar <lukeslakemail@gmail.com>
Date: Thu, 14 Aug 2025 22:05:26 -0500
Subject: [PATCH] docs: enhance README with setup instructions for skia-canvas
 dependencies and usage statistics tracker

---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 49 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 3365745..969e7d2 100644
--- a/README.md
+++ b/README.md
@@ -96,26 +96,68 @@ gcloud auth application-default login
 
 ### As a GitHub Action
 
+> **⚠️ Important**: This action requires native dependencies for chart generation. Run the setup command before using the action.
+> 
+> **What happens if you skip this step?** The action will fail with a `Cannot find module '../v8'` error when trying to generate charts. The setup command installs the system libraries needed to compile the native `skia-canvas` module.
+
+**Quick Start:**
 ```yaml
+- name: Install dependencies
+  run: sudo apt-get update && sudo apt-get install -y build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev libpixman-1-dev pkg-config python3 make g++ libstdc++6
+
 - name: Usage Statistics Tracker
   uses: LukeHagar/usage-statistics@v1
   with:
     npm-packages: 'lodash,axios'
     github-repositories: 'microsoft/vscode,facebook/react'
     pypi-packages: 'requests,numpy'
-    homebrew-formulas: 'git,node'
     powershell-modules: 'PowerShellGet,PSReadLine'
-    postman-collections: '12345,67890'
-    # go-modules removed
     json-output-path: 'stats.json'
-    csv-output-path: 'stats.csv'
-    report-output-path: 'report.md'
     update-readme: 'true'
     github-token: ${{ secrets.GITHUB_TOKEN }}
-  # env:
-  #   PYPI_STATS_BASE_URL: https://your-host
 ```
 
+**Detailed Setup:**
+```yaml
+- name: Install system dependencies for skia-canvas
+  run: |
+    sudo apt-get update
+    sudo apt-get install -y build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev libpixman-1-dev pkg-config python3 make g++ libstdc++6
+
+- name: Usage Statistics Tracker
+  uses: LukeHagar/usage-statistics@v1
+  with:
+    npm-packages: 'lodash,axios'
+    github-repositories: 'microsoft/vscode,facebook/react'
+    pypi-packages: 'requests,numpy'
+    powershell-modules: 'PowerShellGet,PSReadLine'
+    json-output-path: 'stats.json'
+    update-readme: 'true'
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+#### Alternative: One-Line Setup
+
+For convenience, you can use this one-liner to install all dependencies:
+
+```yaml
+- name: Install dependencies
+  run: sudo apt-get update && sudo apt-get install -y build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev libpixman-1-dev pkg-config python3 make g++ libstdc++6
+
+- name: Usage Statistics Tracker
+  uses: LukeHagar/usage-statistics@v1
+  with:
+    npm-packages: 'lodash,axios'
+    github-repositories: 'microsoft/vscode,facebook/react'
+    pypi-packages: 'requests,numpy'
+    powershell-modules: 'PowerShellGet,PSReadLine'
+    json-output-path: 'stats.json'
+    update-readme: 'true'
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+> **💡 Tip**: The one-liner is the same as the "Quick Start" example above - just a more compact format!
+
 ### Local Development
 
 ```bash