Skip to content

Commit 1e65933

Browse files
committed
updating docs
1 parent 17cef05 commit 1e65933

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ QuickPose provides developer-oriented cutting edge ML features of MediaPipe and
1111

1212
- [How it works](#how-it-works)
1313
- [Features](#features)
14+
- [Meta Features](#meta-features)
1415
- [Supported Platforms](#supported-platforms)
1516
- [Requirements](#requirements)
1617
- [Installing the SDK](#installing-the-sdk)
@@ -51,10 +52,15 @@ Features
5152
| ------------- |:-------------:| ---------:|
5253
| MediaPipe Landmarks | ![MediaPipe Landmarks](docs/v0.2/overlay-all-points.gif) | v0.1 |
5354
| <p><b>Overlays</b></p><p>Whole Body</p><p>Upper Body</p><p>Lower Body</p><p>Shoulder</p><p>Left Arm</p><p>Right Arm</p><p>Left Leg</p><p>Right Leg</p> | ![Whole Body Overlay](docs/v0.1/overlay-whole-body.gif) ![Upper Body Overlay](docs/v0.1/overlay-upper-body.gif) ![Lower Body Overlay](docs/v0.1/overlay-lower-body.gif) ![Shoulders Overlay](docs/v0.1/overlay-shoulders.gif) ![Left Leg Overlay](docs/v0.1/overlay-left-leg.gif) ![Right Leg Overlay](docs/v0.1/overlay-right-leg.gif)| v0.1 |
54-
| <p><b>Health - Range Of Motion</b></p><p>Left Shoulder</p><p>Right Shoulder</p><p>Left Hip</p><p>Right Hip</p><p>Left Knee</p><p>Right Knee</p><p>Back</p><p>Neck</p> | ![health-shoulder-right-rom](docs/v0.3/health-shoulder-right-rom.gif) ![health-shoulder-rom](docs/v0.3/health-shoulder-rom.gif) ![health-hip-rom](docs/v0.3/health-hip-rom.gif) ![health-knee-rom](docs/v0.3/health-knee-rom.gif) ![health-back-rom](docs/v0.3/health-back-rom.gif) ![health-neck-rom](docs/v0.3/health-neck-rom.gif) | v0.3 | |
55-
| <p><b>Fitness - Exercise Detection & Counter</b></p><p>Squat</p><p>Jumping Jack</p> | ![fitness-squat-counter](docs/v0.3/fitness-squat-counter.gif) ![fitness-jacks-counter](docs/v0.3/fitness-jacks-counter.gif) | v0.3 | |
55+
| <p><b>Health - Range Of Motion</b></p><p>Left Shoulder</p><p>Right Shoulder</p><p>Left Hip</p><p>Right Hip</p><p>Left Knee</p><p>Right Knee</p><p>Back</p><p>Neck</p> | ![health-shoulder-right-rom](docs/v0.3/health-shoulder-right-rom.gif) ![health-shoulder-rom](docs/v0.3/health-shoulder-rom.gif) ![health-hip-rom](docs/v0.3/health-hip-rom.gif) ![health-knee-rom](docs/v0.3/health-knee-rom.gif) ![health-back-rom](docs/v0.3/health-back-rom.gif) ![health-neck-rom](docs/v0.3/health-neck-rom.gif) | v0.3 |
56+
| <p><b>Fitness - Exercise Detection & Counter</b></p><p>Squat</p><p>Jumping Jack</p> | ![fitness-squat-counter](docs/v0.3/fitness-squat-counter.gif) ![fitness-jacks-counter](docs/v0.3/fitness-jacks-counter.gif) | v0.3 |
5657

58+
Meta Features
59+
------------------
5760

61+
| Feature | Example | Supported |
62+
| ------------- |:-------------:| ---------:|
63+
| Conditional Styling | ![knee-conditional-image](docs/v0.4/health-knee-rom-conditional.gif) ![shoulder-conditional-image](docs/v0.4/health-shoulder-rom-conditional.gif) | v0.4 |
5864

5965
Supported Platforms
6066
------------------
@@ -88,8 +94,8 @@ __Step 4__: Choose all modules and click add package.
8894
| --------------|--------------------:|
8995
| QuickPoseCore | Core SDK (required) |
9096
| QuickPoseMP | Mediapipe Library (required) |
91-
| QuickPoseCamera | Utility Class for UIKit Integration (optional) |
92-
| QuickPoseSwiftUI | Utility Classes for SwiftUI Integration (optional) |
97+
| QuickPoseCamera | Utility Class for Integration (optional, recommended) |
98+
| QuickPoseSwiftUI | Utility Classes for SwiftUI Integration (optional, recommended)|
9399

94100
Get an SDK Key
95101
------------------

0 commit comments

Comments
 (0)