docs: update README

README.md

@@ -14,7 +14,7 @@
       <a href="https://www.conventionalcommits.org/en/v1.0.0/">
       <img alt="conventionalcommits" src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?style=for-the-badge&logo=conventionalcommits&color=ee99a0&logoColor=D9E0EE&labelColor=302D41"></a>
       <a href="https://github.com/vn7n24fzkq/github-profile-summary-cards/actions/workflows/github-action.yml">
-      <img alt="testandlint" src="https://img.shields.io/github/workflow/status/vn7n24fzkq/github-profile-summary-cards/Test%20and%20Lint?label=Test%20and%20Lint&style=for-the-badge&color=a6da95"></a>
+      <img alt="testandlint" src="https://img.shields.io/github/actions/workflow/status/vn7n24fzkq/github-profile-summary-cards/test-and-lint.yml?branch=main&label=Test%20and%20Lint&style=for-the-badge&color=a6da95"></a>
    </p>
    <p align="center">
       <a href="https://docs.runforesight.com">
@@ -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!