diff --git a/README.md b/README.md
index 12d956b2d..fc8d544b7 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
-
+
@@ -94,6 +94,56 @@ high-quality software at speed with Foresight.
[More themes](https://github.com/vn7n24fzkq/github-profile-summary-cards-example/tree/master/profile-summary-card-output)
+## How to use (API)
+### Profile details card
+![](http://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=nord_bright)
+
+`http://github-profile-summary-cards.vercel.app/api/cards/profile-details?username={username}&theme={theme_name}`
+- accept url parameters
+ - theme
+ - username
+### Top languages used in repository card
+![](http://github-profile-summary-cards.vercel.app/api/cards/repos-per-language?username=vn7n24fzkq&theme=nord_bright)
+
+`http://github-profile-summary-cards.vercel.app/api/cards/repos-per-language?username={username}&theme={theme_name}&exclude={exclude}`
+- accept url parameters
+ - theme
+ - theme name
+ - username
+ - exclude:
+ - A comma separated list of languages to exclude, e.g., exclude=java,rust
+ - You can found the supported languages in [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
+
+### Top languages in commits card
+![](http://github-profile-summary-cards.vercel.app/api/cards/most-commit-language?username=vn7n24fzkq&theme=nord_bright)
+
+`http://github-profile-summary-cards.vercel.app/api/cards/most-commit-language?username={username}&theme={theme_name}&exclude={exclude}`
+- accept url parameters
+ - theme
+ - username
+ - exclude:
+ - A comma separated list of languages to exclude, e.g., exclude=java,rust
+ - You can found the supported languages in [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
+
+``
+### GitHub stats card
+![](http://github-profile-summary-cards.vercel.app/api/cards/stats?username=vn7n24fzkq&theme=nord_bright&)
+
+`http://github-profile-summary-cards.vercel.app/api/cards/stats?username={username}&theme={theme_name}`
+- accept url parameters
+ - theme
+ - username
+
+``
+### Productive time card
+![](http://github-profile-summary-cards.vercel.app/api/cards/productive-time?username=vn7n24fzkq&theme=nord_bright&utcOffset=8)
+
+`http://github-profile-summary-cards.vercel.app/api/cards/productive-time?username={username}&theme={theme_name}&utcOffset={utcOffset}`
+- accept url parameters
+ - theme
+ - username
+ - utcOffset
+
---
## How to use (GitHub Actions)
@@ -178,6 +228,12 @@ Example
npm run run vn7n24fzkq 8
```
+- To locally run the API you can use the vercel dev package
+
+```sh
+vercel dev
+```
+
## Deploy your own API on Vercel
Quickly deploy your own version!