Skip to content

Commit 3c9a1f1

Browse files
cyberboyanmolcyberboyanmol
committed
docs(readme): revamped README with dataset clarification, API playground links, contact info, and usage examples
1 parent a38e227 commit 3c9a1f1

File tree

5 files changed

+147
-108
lines changed

5 files changed

+147
-108
lines changed

‎README.md

Lines changed: 128 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,127 @@
11

2-
# 🚀 New Exercise Dataset
3-
4-
What's Inside Our New Dataset
5-
- 3,000+ exercises
6-
- High-quality video demonstration.
7-
- High-quality images
8-
- Multilingual supports
9-
- Many More..
10-
11-
12-
Check out the [Pricing Plan](https://dub.sh/JTgJoq2) for detailed information.
13-
For inquiries:
14-
Telegram: [@cyberboyanmol](https://t.me/cyberboyanmol) (fast response)
15-
16-
## Note: Enterprise Solutions
17-
If you're building an application and need complete control over the exercise data, we offer offline dataset access instead of API as SaaS. This includes:
18-
19-
- Full offline access to all 3,000+ exercises
20-
- with montly/annually subscription
21-
- Regular dataset updates
22-
- Custom data formats
23-
- Unlimited usage rights
24-
- Direct technical support
25-
- Integration assistance
2+
<div align="center">
3+
<img src="https://cdn.exercisedb.dev/exercisedb/exercisedb_banner.png" alt="ExerciseDB API Banner" width="100%" height="600px" />
4+
5+
<br />
6+
<br />
7+
<img src="https://cdn.exercisedb.dev/exercisedb/android-chrome-512x512.png" alt="ExerciseDB Logo" width="120" height="120" />
268

27-
Exercise sample
28-
```sh
9+
<h3>🏋️‍♂️ Comprehensive Fitness Exercise Database API</h3>
10+
11+
<p>
12+
<strong>5,000+ structured exercises</strong> • <strong>Fast & Modern</strong> • <strong>Developer-Friendly</strong>
13+
</p>
14+
15+
<p>
16+
<span style="margin-right: 10px;">
17+
<a href="https://dub.sh/exercisedb-api">
18+
<img src="https://img.shields.io/badge/Get%20Started-2D2D2D?style=for-the-badge&logo=rocket&logoColor=white" alt="Get Started" />
19+
</a>
20+
</span>
21+
<span style="margin-right: 10px;">
22+
<a href="https://docs.exercisedb.dev">
23+
<img src="https://img.shields.io/badge/Documentation-404040?style=for-the-badge&logo=book&logoColor=white" alt="Documentation" />
24+
</a>
25+
</span>
26+
<span>
27+
<a href="#examples">
28+
<img src="https://img.shields.io/badge/Examples-5A5A5A?style=for-the-badge&logo=code&logoColor=white" alt="Examples" />
29+
</a>
30+
</span>
31+
</p>
32+
33+
</div>
34+
35+
36+
## 🏋🏼‍♀️ ExerciseDB API
37+
38+
ExerciseDB API is a **comprehensive and developer-friendly database** featuring over **5,000 structured, high-quality fitness exercises**. It delivers fast, modern, and scalable access to detailed exercise data—including targeted muscle groups, required equipment, visual aids (images and videos), and step-by-step instructions. Ideal for developers, fitness startups, and health platforms, ExerciseDB empowers the creation of smart workout apps, personalized training plans, and interactive fitness tools.
39+
40+
**Perfect for:**
41+
- 💪 Fitness app developers
42+
- 🏃‍♀️ Health & wellness platforms
43+
- 🎯 Personal training applications
44+
- 📱 Workout planning tools
45+
- 🔬 Fitness research projects
46+
47+
<br>
48+
49+
## 🔗 Useful Links
50+
51+
<div align="left">
52+
53+
### 📚 **Documentation & Plans**
54+
55+
<a href="https://dub.sh/JTgJoq2" target="_blank">
56+
<img src="https://img.shields.io/badge/Full%20Documentation-2D2D2D?style=for-the-badge&logo=notion&logoColor=white" alt="Full Documentation" />
57+
</a>
58+
<a href="https://dub.sh/JTgJoq2" target="_blank">
59+
<img src="https://img.shields.io/badge/Pricing%20Plans-404040?style=for-the-badge&logo=credit-card&logoColor=white" alt="Pricing Plans" />
60+
</a>
61+
<a href="https://dub.sh/exercisedb-api-tos" target="_blank">
62+
<img src="https://img.shields.io/badge/Terms%20Of%20Use-2D2D2D?style=for-the-badge&logo=notion&logoColor=white" alt="Terms of use" />
63+
</a>
64+
<br>
65+
66+
### 🧪 **API Playground**
67+
68+
<strong>Test our datasets and explore API endpoints</strong><br>
69+
<em>⚠️ These endpoints are for exploration only and <strong>not recommended for production integration</strong> — strict rate limits and potential instability may apply.</em>
70+
<br><br>
71+
**Note:** V1 and V2 refer to different datasets.
72+
<br>
73+
<p>
74+
<a href="https://dub.sh/exercisedb_v2" target="_blank">
75+
<img src="https://img.shields.io/badge/v2%20Playground-5A5A5A?style=for-the-badge&logo=play&logoColor=white" alt="v2 Playground" />
76+
</a>
77+
<a href="https://dub.sh/exercisedb_v1" target="_blank">
78+
<img src="https://img.shields.io/badge/v1%20Playground-5A5A5A?style=for-the-badge&logo=play&logoColor=white" alt="v1 Playground" />
79+
</a>
80+
</p>
81+
82+
</div>
83+
84+
85+
## 📬 Support & Contact
86+
87+
<div align="left">
88+
89+
<p><strong>Need help or have questions? We're here to assist!</strong></p>
90+
91+
<table>
92+
<tr>
93+
<td align="left">
94+
<a href="mailto:hello@exercisedb.dev">
95+
<img src="https://img.shields.io/badge/General%20Inquiries-2D2D2D?style=for-the-badge&logo=mail&logoColor=white" alt="General Inquiries" />
96+
</a>
97+
<br>
98+
<small>✉️ Partnerships & General Questions</small>
99+
</td>
100+
<td align="left">
101+
<a href="mailto:support@exercisedb.dev">
102+
<img src="https://img.shields.io/badge/Technical%20Support-404040?style=for-the-badge&logo=wrench&logoColor=white" alt="Technical Support" />
103+
</a>
104+
<br>
105+
<small>🛠️ API Help & Technical Issues</small>
106+
</td>
107+
<td align="left">
108+
<a href="https://t.me/exercisedb" target="_blank">
109+
<img src="https://img.shields.io/badge/Chat%20With%20Us-5A5A5A?style=for-the-badge&logo=message-circle&logoColor=white" alt="Chat With Us" />
110+
</a>
111+
<br>
112+
<small>💬 Live Chat Support (Fast Response)</small>
113+
</td>
114+
</tr>
115+
</table>
116+
117+
</div>
118+
119+
120+
<br>
121+
122+
## 🏋️‍♂️ V2 Exercise Sample
123+
124+
```json
29125
{
30126
"exerciseId": "K6NnTv0",
31127
"name": "Bench Press",
@@ -83,65 +179,17 @@ Exercise sample
83179
"dCSgT7N"
84180
]
85181
}
86-
87182
```
88-
Sample Image
89-
90-
![Bench Press Exercise](https://ucarecdn.com/c12bb487-7390-4fc7-903c-a1c2298e70ad/K6NnTv0__BarbellBenchPress_Chest.png)
91-
92-
Sample Video
93-
94-
https://github.com/user-attachments/assets/6845a963-4d80-4dfd-b602-e49616a9483f
95-
96-
97-
# ExerciseDB API
98183

99-
![GitHub License](https://img.shields.io/github/license/cyberboyanmol/exercisedb-api)
100-
![GitHub Release](https://img.shields.io/github/v/release/cyberboyanmol/exercisedb-api)
184+
### 🖼️ Sample Image
101185

102-
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.
103-
104-
## ⚠️ Important Notice
105-
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.
106-
107-
## 📚 Documentation
108-
109-
Check out the [API documentation](https://exercisedb-api.vercel.app/docs) for detailed information on how to use the API.
110-
111-
## 📰 Changelog
112-
113-
For a detailed list of changes, see the [CHANGELOG](CHANGELOG.md).
114-
115-
## 🔌 Running Locally
116-
117-
> [!NOTE]
118-
> You need `Bun(1.1.25+)` or `Node.js(v20+)`
119-
120-
1. Clone the repository:
121-
122-
```sh
123-
git clone https://github.com/cyberboyanmol/exercisedb-api
124-
cd exercisedb-api
125-
```
126-
127-
2. Install the required dependencies:
128-
129-
```sh
130-
bun install
131-
```
132-
133-
3. Launch the development server:
134-
135-
```sh
136-
bun run dev
137-
```
186+
![Bench Press Exercise](https://ucarecdn.com/c12bb487-7390-4fc7-903c-a1c2298e70ad/K6NnTv0__BarbellBenchPress_Chest.png)
138187

139-
## ☁️ Deploying Your Own Instance
188+
### 🎥 Sample Video
140189

141-
You can easily deploy your own instance of the API by clicking the button below:
190+
[Watch Bench Press Video Sample](https://github.com/user-attachments/assets/6845a963-4d80-4dfd-b602-e49616a9483f)
142191

143-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/cyberboyanmol/exercisedb-api)
144192

145-
## 📜 License
193+
---
146194

147-
This project is distributed under the [MIT License](https://opensource.org/licenses/MIT). For more information, see the issue [ISSUE](https://github.com/cyberboyanmol/exercisedb-api/issues/3) included in this repository.
195+
<em>💪 Now that you’ve bench pressed through the sample… go lift the rest of the v2 dataset like a champ! 😄<em>

‎package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "exercisedb-api",
3-
"description": "Free ExerciseDB API",
4-
"repository": "https://github.com/cyberboyanmol/exercisedb-api",
3+
"description": "ExerciseDB API",
4+
"repository": "https://github.com/exercisedb/exercisedb-api",
55
"version": "0.0.7",
6-
"author": "Anmol Gangwar",
6+
"author": "ExerciseDB API",
77
"license": "MIT",
88
"type": "module",
99
"main": "dist/server.js",

‎src/app.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export class App {
7979
version: '1.0.0',
8080
title: 'ExerciseDB API',
8181
description: `# Introduction
82-
\nExerciseDB 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.
82+
\nExerciseDB API, accessible at [v1.exercisedb.dev](https://v1.exercisedb.dev), is an exercises API that allows users to access high-quality exercises data which consists 1300+ exercises.
8383
This API offers extensive information on each exercise, including target body parts, equipment needed, GIFs for visual guidance, and step-by-step instructions.\n`
8484
},
8585

@@ -102,9 +102,9 @@ export class App {
102102
darkMode: true,
103103
metaData: {
104104
applicationName: 'ExerciseDB API',
105-
author: 'Anmol Gangwar',
106-
creator: 'Anmol Gangwar',
107-
publisher: 'Anmol Gangwar',
105+
author: 'ExerciseDB API',
106+
creator: 'ExerciseDB API',
107+
publisher: 'ExerciseDB API',
108108
robots: 'index follow',
109109
description:
110110
'Access detailed data on over 1300+ exercises with the ExerciseDB API. This API offers extensive information on each exercise, including target body parts, equipment needed, GIFs for visual guidance, and step-by-step instructions.'
@@ -122,7 +122,7 @@ export class App {
122122
return c.json(
123123
{
124124
success: false,
125-
message: 'oops route not found!!. check docs at https://exercisedb-api.vercel.app/docs'
125+
message: 'oops route not found!!. check docs at https://v1.exercisedb.dev/docs'
126126
},
127127
404
128128
)

‎src/pages/home.tsx

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ Home.get('/', (c) => {
3333
<meta charset="utf-8" />
3434
<meta name="description" content={description} />
3535
<meta property="og:type" content="website" />
36-
<meta property="og:url" content="https://github.com/cyberboyanmol/exercisedb-api" />
36+
<meta property="og:url" content="https://github.com/exercisedb/exercisedb-api" />
3737
<meta property="og:title" content={title} />
3838
<meta property="og:description" content={description} />
3939
<meta property="twitter:card" content="summary_large_image" />
40-
<meta property="twitter:url" content="https://github.com/cyberboyanmol/exercisedb-api" />
40+
<meta property="twitter:url" content="https://github.com/exercisedb/exercisedb-api" />
4141
<meta property="twitter:title" content={title} />
4242
<meta property="twitter:description" content={description} />
4343
<link rel="preconnect" href="https://fonts.googleapis.com" />
@@ -106,7 +106,7 @@ Home.get('/', (c) => {
106106
<a
107107
target="_blank"
108108
class="p-4 sm:p-8 hover:bg-opacity-5 hover:bg-white rounded-lg duration-100 sm:col-span-4"
109-
href="https://github.com/cyberboyanmol/exercisedb-api"
109+
href="https://github.com/exercisedb/exercisedb-api"
110110
>
111111
<div class="flex flex-col">
112112
<span class="text-xs uppercase bg-opacity-15 rounded text-center max-w-fit px-2 py-1 font-bold tracking-wide bg-green-500 text-green-500">
@@ -122,7 +122,7 @@ Home.get('/', (c) => {
122122
<a
123123
target="_blank"
124124
class="p-4 sm:p-8 hover:bg-opacity-5 hover:bg-white rounded-lg duration-100 sm:col-span-4"
125-
href="https://github.com/cyberboyanmol/exercisedb-api/issues"
125+
href="https://github.com/exercisedb/exercisedb-api/issues"
126126
>
127127
<div class="flex flex-col">
128128
<span class="text-xs uppercase bg-opacity-15 rounded text-center max-w-fit px-2 py-1 font-bold tracking-wide bg-violet-500 text-violet-500">
@@ -141,11 +141,11 @@ Home.get('/', (c) => {
141141
<span class="text-xs uppercase bg-opacity-15 rounded text-center max-w-fit px-2 py-1 font-bold tracking-wide bg-blue-500 text-blue-500">
142142
Contact
143143
</span>
144-
<span class="text-neutral-200 font-bold text-lg sm:text-xl md:text-2xl mt-2">Anmol Gangwar</span>
144+
<span class="text-neutral-200 font-bold text-lg sm:text-xl md:text-2xl mt-2">ExerciseDB API</span>
145145
<div class="text-neutral-500 mt-2">
146146
Have a question or need help? Reach out on{' '}
147147
<a
148-
href="https://github.com/cyberboyanmol"
148+
href="https://github.com/exercisedb"
149149
target="_blank"
150150
rel="noopener noreferrer"
151151
className="hover:underline text-indigo-500"
@@ -154,21 +154,12 @@ Home.get('/', (c) => {
154154
</a>
155155
,{' '}
156156
<a
157-
href="https://twitter.com/cyberboyanmol"
158-
target="_blank"
159-
rel="noopener noreferrer"
160-
className="hover:underline text-sky-500"
161-
>
162-
Twitter
163-
</a>
164-
, or{' '}
165-
<a
166-
href="https://t.me/cyberboyanmol"
157+
href="https://t.me/exercisedb"
167158
target="_blank"
168159
rel="noopener noreferrer"
169160
className="hover:underline text-pink-500"
170161
>
171-
Telegram.
162+
Chat With Us.
172163
</a>
173164
</div>
174165
</div>

‎vercel.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "https://openapi.vercel.sh/vercel.json",
33
"rewrites": [{ "source": "(.*)", "destination": "/api" }],
4-
"regions": ["bom1"],
4+
"regions": ["sfo1"],
55
"outputDirectory": "dist",
66
"headers": [
77
{
@@ -25,11 +25,11 @@
2525
},
2626
{
2727
"key": "Author",
28-
"value": "Anmol Gangwar"
28+
"value": "ExerciseDB API"
2929
},
3030
{
3131
"key": "Github",
32-
"value": "https://github.com/cyberboyanmol/exercisedb-api"
32+
"value": "https://github.com/exercisedb/exercisedb-api"
3333
}
3434
]
3535
}

0 commit comments

Comments
 (0)