Skip to content

Commit a7fd9b1

Browse files
committed
add tutorial
1 parent 829892c commit a7fd9b1

5 files changed

Lines changed: 48 additions & 0 deletions

File tree

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,54 @@
1414

1515
---
1616

17+
## 🎬 Quick Tutorial
18+
19+
### Getting Started in 4 Steps
20+
21+
**Step 1: Export Your Data**
22+
<div align="center">
23+
<img src="./Step1.png" alt="Export data from Hevy app" width="400" />
24+
</div>
25+
26+
- Open the Hevy app on your phone
27+
- Go to Settings → Export Data
28+
- Download your workout CSV file
29+
30+
**Step 2: Upload to HevyAnalytics**
31+
<div align="center">
32+
<img src="./Step2.png" alt="Upload CSV to HevyAnalytics" width="400" />
33+
</div>
34+
35+
- Open HevyAnalytics (run `npm run dev` locally or visit the deployed site)
36+
- Click the **Upload CSV** button at the top
37+
- Select your downloaded CSV file
38+
- Watch as your data loads instantly into the app
39+
40+
**Step 3: Explore Your Analytics**
41+
<div align="center">
42+
<img src="./Step3.png" alt="Explore analytics dashboard" width="400" />
43+
</div>
44+
45+
- **Dashboard** - See your training volume, workout frequency, and key metrics at a glance
46+
- **Exercises** - Check personal records, 1RM estimates, and performance trends for each lift
47+
- **History** - Review detailed logs of every workout session with filtering options
48+
49+
**Step 4: Get Insights & Filter**
50+
<div align="center">
51+
<img src="./Step4.png" alt="Get real-time feedback and filter data" width="400" />
52+
</div>
53+
54+
🎯 **Filter by Month** - Use the date dropdown to focus on specific training periods
55+
56+
📊 **Real-Time Feedback** - Get set-by-set wisdom indicators while browsing your data:
57+
- ✅ Green (Success) - You're hitting your targets
58+
- ⚠️ Yellow (Warning) - Performance is changing
59+
- 🔥 Red (Danger) - Significant drop-off detected
60+
61+
💾 **Your Data Stays Private** - Everything is saved locally in your browser—nothing is sent to servers
62+
63+
---
64+
1765
## 📋 Table of Contents
1866

1967
- [HevyAnalytics 🏋️](#hevyanalytics-️)

Step1.png

82 KB
Loading

Step2.png

129 KB
Loading

Step3.png

55.5 KB
Loading

Step4.png

141 KB
Loading

0 commit comments

Comments
 (0)