Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberboyanmol authored Jan 6, 2025
1 parent 14e8392 commit 2026f10
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,44 @@

ExerciseDB API, accessible at [exercisedb-api.vercel.app](https://exercisedb-api.vercel.app/), is an exercises API that allows users to access high-quality exercises data which consists 1300+ exercises. This API offers extensive information on each exercise, including target body parts, equipment needed, GIFs for visual guidance, and step-by-step instructions.

## ⚠️ Important Notice
The unauthorized downloading, scraping, or bulk collection of data from this API is strictly prohibited. This API is intended for individual exercise lookups and legitimate application integration only. If you need access to the complete dataset or have specific requirements, please contact via Telegram at [@cyberboyanmol](https://t.me/cyberboyanmol). We're happy to discuss proper data usage and potential collaborations.

## 📚 Documentation

Check out the [API documentation](https://exercisedb-api.vercel.app/docs) for detailed information on how to use the API.

## Sample Dataset

```sh
{
"exerciseId": "guT8YnS",
"name": "biceps pull-up",
"gifUrl": "https://cdn-exercisedb.vercel.app/api/v1/images/guT8YnS.gif",
"instructions": [
"Step:1 Hang from a pull-up bar with your palms facing away from you and your hands shoulder-width apart.",
"Step:2 Engage your core and pull yourself up by bending your elbows, bringing your chest towards the bar.",
"Step:3 Pause at the top of the movement, then slowly lower yourself back down to the starting position.",
"Step:4 Repeat for the desired number of repetitions."
],
"targetMuscles": [
"biceps"
],
"bodyParts": [
"upper arms"
],
"equipments": [
"body weight"
],
"secondaryMuscles": [
"forearms",
"shoulders"
]
}
```
![Chest Dip Exercise](https://ucarecdn.com/02aab038-31da-4127-af94-30cfbb93d47f/guT8YnS.gif)


## 📰 Changelog

For a detailed list of changes, see the [CHANGELOG](CHANGELOG.md).
Expand Down

0 comments on commit 2026f10

Please sign in to comment.