Update README.md

README.md

@@ -1,94 +1,132 @@
+<a name="readme-top"></a>
 
+<div align="center">
+
+<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-logo/1.0.0/files/assets/logo-3d.webp">
+<img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
+<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/puzzle-piece.webp">
 
-> 📊 Total: <kbd>**3**</
+<h1>Chat Plugin SDK</h1>
 
-> 📊 Total: <kbd>**3**</kbd>
+SDK for LobeChat funciton calling plugins
+
+[Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]
+
+<!-- SHIELD GROUP -->
 
-<a href="https://github.com/arvinxx" title="arvinxx">
-  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
-</a>
-<a href="https://github.com/actions-user" title="actions-user">
-  <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
-</a>
-<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
-  <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
-</a>
+[![release][release-shield]][release-url]
+[![releaseDate][release-date-shield]][release-date-url]
+[![ciTest][ci-test-shield]][ci-test-url]
+[![ciRelease][ci-release-shield]][ci-release-url]
+<br/>
+[![contributors][contributors-shield]][contributors-url]
+[![forks][forks-shield]][forks-url]
+[![stargazers][stargazers-shield]][stargazers-url]
+[![issues][issues-shield]][issues-url]
+
+![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
 
+</div>
 
+## ⌨️ Local Development
 
-> 📊 Total: <kbd>**3**</
+You can use Gitpod for online development:
 
-> 📊 Total: <kbd>**3**</kbd>
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod-url]
 
-<a href="https://github.com/arvinxx" title="arvinxx">
-  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
-</a>
-<a href="https://github.com/actions-user" title="actions-user">
-  <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
-</a>
-<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
-  <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
-</a>
+Or clone it for local development:
 
+```bash
+$ git clone https://github.com/lobehub/chat-plugin-sdk.git
+$ cd canisminor-template
+$ npm install
+$ npm start
+```
 
+<div align="right">
 
-> 📊 Total: <kbd>**3**</
+[![][back-to-top]](#readme-top)
+
+</div>
+
+
+## 🤝 Contributing
+
+<!-- CONTRIBUTION GROUP -->
 
 > 📊 Total: <kbd>**3**</kbd>
 
-<a href="https://github.com/arvinxx" title="arvinxx">
-  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
-</a>
 <a href="https://github.com/actions-user" title="actions-user">
   <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
 </a>
-<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
-  <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
+<a href="https://github.com/canisminor1990" title="canisminor1990">
+  <img src="https://avatars.githubusercontent.com/u/17870709?v=4" width="50" />
+</a>
+<a href="https://github.com/arvinxx" title="arvinxx">
+  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
 </a>
 
+<!-- CONTRIBUTION END -->
 
+<div align="right">
 
-> 📊 Total: <kbd>**3**</
+[![][back-to-top]](#readme-top)
 
-> 📊 Total: <kbd>**3**</kbd>
+</div>
 
-<a href="https://github.com/arvinxx" title="arvinxx">
-  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
-</a>
-<a href="https://github.com/actions-user" title="actions-user">
-  <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
-</a>
-<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
-  <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
-</a>
+---
+#### 📝 License
 
+Copyright © 2023 [LobeHub][profile-url]. <br />
+This project is [MIT](./LICENSE) licensed. 
 
 
-> 📊 Total: <kbd>**3**</
+<!-- LINK GROUP -->
 
-> 📊 Total: <kbd>**3**</kbd>
+[profile-url]: https://github.com/lobehub
+[issues-url]: https://github.com/lobehub/chat-plugin-sdk/issues/new/choose
+[gitpod-url]: https://gitpod.io/#https://github.com/lobehub/chat-plugin-sdk
 
-<a href="https://github.com/arvinxx" title="arvinxx">
-  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
-</a>
-<a href="https://github.com/actions-user" title="actions-user">
-  <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
-</a>
-<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
-  <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
-</a>
+<!-- SHIELD LINK GROUP -->
 
+[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
 
+<!-- release -->
 
-> 📊 Total: <kbd>**3**</kbd>
+[release-shield]: https://img.shields.io/npm/v/@lobehub/chat-plugin-sdk?label=%F0%9F%A4%AF%20NPM
+[release-url]: https://www.npmjs.com/package/@lobehub/chat-plugin-sdk
 
-<a href="https://github.com/arvinxx" title="arvinxx">
-  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
-</a>
-<a href="https://github.com/actions-user" title="actions-user">
-  <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
-</a>
-<a href="https://github.com/apps/dependabot" title="dependabot[bot]">
-  <img src="https://avatars.githubusercontent.com/in/29110?v=4" width="50" />
-</a>
+<!-- releaseDate -->
+
+[release-date-shield]: https://img.shields.io/github/release-date/lobehub/chat-plugin-sdk?style=flat
+[release-date-url]: https://github.com/lobehub/chat-plugin-sdk/releases
+
+<!-- ciTest -->
+
+[ci-test-shield]: https://github.com/lobehub/chat-plugin-sdk/workflows/Test%20CI/badge.svg
+[ci-test-url]: https://github.com/lobehub/chat-plugin-sdk/actions/workflows/test.yml
+
+<!-- ciRelease -->
+
+[ci-release-shield]: https://github.com/lobehub/chat-plugin-sdk/workflows/Release%20CI/badge.svg
+[ci-release-url]: https://github.com/lobehub/chat-plugin-sdk/actions?query=workflow%3ARelease%20CI
+
+<!-- contributors -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/lobehub/chat-plugin-sdk.svg?style=flat
+[contributors-url]: https://github.com/lobehub/chat-plugin-sdk/graphs/contributors
+
+<!-- forks -->
+
+[forks-shield]: https://img.shields.io/github/forks/lobehub/chat-plugin-sdk.svg?style=flat
+[forks-url]: https://github.com/lobehub/chat-plugin-sdk/network/members
+
+<!-- stargazers -->
+
+[stargazers-shield]: https://img.shields.io/github/stars/lobehub/chat-plugin-sdk.svg?style=flat
+[stargazers-url]: https://github.com/lobehub/chat-plugin-sdk/stargazers
+
+<!-- issues -->
 
+[issues-shield]: https://img.shields.io/github/issues/lobehub/chat-plugin-sdk.svg?style=flat
+[issues-url]: https://img.shields.io/github/issues/lobehub/chat-plugin-sdk.svg?style=flat