LukeParke/usage-statistics
1
0
Fork 0
mirror of https://github.com/LukeHagar/usage-statistics.git synced 2025-12-06 04:21:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: enhance README with setup instructions for skia-canvas dependencies and usage statistics tracker

Browse Source
This commit is contained in:
Luke Hagar
2025-08-14 22:05:26 -05:00
parent 0f072b8d0f
commit 52db9b8131
1 changed files with 49 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@@ -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