docs: update readme

Matthew0x · Apr 8, 2021 · 6fa4a64 · 6fa4a64
1 parent fec7d89
commit 6fa4a64
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -10,11 +10,21 @@ This repo is inspired by [profile-summary-for-github](https://github.com/tipsy/p
 
 :star: This repo just for fun, feel free to contribution! :star:
 
-This action generate your github profile summary cards and make a commit to your repo.
-You can also trigger action by yourself after add this action.
-
 ---
 
+## Markdown Usage
+
+[Try it now!!](https://github-profile-summary-cards.vercel.app/demo.html)
+
+```![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=vue)```
+
+|   |   |   |
+|:---:|:---:|:---:|
+|default|solarized|monokai|
+|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=default)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=solarized)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=monokai)|
+|solarized_dark|vue|nord_bright|
+|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=solarized_dark)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=vue)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=nord_bright)|
+
 ## Example
 
 ![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/0-profile-details.svg)
@@ -27,7 +37,10 @@ You can also trigger action by yourself after add this action.
 
 ---
 
-## How to use
+## How to use (GitHub Actions)
+
+This action generate your github profile summary cards and make a commit to your repo.
+You can also trigger action by yourself after add this action.
 
 :star: [Follow tutorial](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Toturial) ( Recommendation ) :star:
 

diff --git a/docs/README.zh-tw.md b/docs/README.zh-tw.md
@@ -10,11 +10,22 @@
 
 :star: 這份 repo 是好玩才寫的,任何貢獻都很歡迎！ :star:
 
-這個 GitHub Action 會產生你的 GitHub 個人統計圖表並且 commit 到你的 repo 裡.
-新增 這個Action 之後你也可以自己觸發 action.
-
 ---
 
+## Markdown 用法
+
+[馬上試試!!](https://github-profile-summary-cards.vercel.app/demo.html)
+
+```![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=vue)```
+
+|   |   |   |
+|:---:|:---:|:---:|
+|default|solarized|monokai|
+|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=default)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=solarized)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=monokai)|
+|solarized_dark|vue|nord_bright|
+|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=solarized_dark)|![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=vue)| ![](https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=nord_bright)|
+
+
 ## 範例
 
 ![](https://raw.githubusercontent.com/vn7n24fzkq/vn7n24fzkq/master/profile-summary-card-output/solarized/0-profile-details.svg)
@@ -27,7 +38,10 @@
 
 ---
 
-## 如何使用
+## 如何使用 (GitHub Actions)
+
+這個 GitHub Action 會產生你的 GitHub 個人統計圖表並且 commit 到你的 repo 裡.
+新增 這個Action 之後你也可以自己觸發 action.
 
 :star: [跟著教學](https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Toturial) ( 推薦 ) :star: