react-muscle-map 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,29 +12,9 @@ npm install react-muscle-map
|
|
|
12
12
|
|
|
13
13
|
React 18 or newer is required as a peer dependency.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Quick start
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
```text
|
|
20
|
-
my-monorepo/
|
|
21
|
-
├── apps/
|
|
22
|
-
│ └── web/
|
|
23
|
-
└── packages/
|
|
24
|
-
└── react-muscle-map/
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
Reference it from the consuming application with the workspace protocol:
|
|
28
|
-
|
|
29
|
-
```json
|
|
30
|
-
{
|
|
31
|
-
"dependencies": {
|
|
32
|
-
"react-muscle-map": "workspace:*"
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
Install dependencies from the monorepo root, then import the component and stylesheet:
|
|
17
|
+
Import the component and stylesheet:
|
|
38
18
|
|
|
39
19
|
```jsx
|
|
40
20
|
import { ExerciseMuscleMap } from 'react-muscle-map'
|
|
@@ -45,14 +25,6 @@ export function MusclePreview() {
|
|
|
45
25
|
}
|
|
46
26
|
```
|
|
47
27
|
|
|
48
|
-
For a project that does not use workspaces, install the copied folder by relative path:
|
|
49
|
-
|
|
50
|
-
```sh
|
|
51
|
-
npm install ../react-muscle-map
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
The copied `muscle-map` folder is sufficient for building and consuming the library. Regenerating its components or packaged datasets requires the source `free-exercise-db` repository and its generator script.
|
|
55
|
-
|
|
56
28
|
## Exercise ID API
|
|
57
29
|
|
|
58
30
|
Use the dataset-aware component when an exercise ID is available. TypeScript accepts only known exercise IDs.
|