diff --git a/README.md b/README.md index 4081259..2d82eee 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,132 @@ + +
+ + + + -> ๐Ÿ“Š Total: **3**Chat Plugin SDK -> ๐Ÿ“Š Total: **3** +SDK for LobeChat funciton calling plugins + +[Changelog](./CHANGELOG.md) ยท [Report Bug][issues-url] ยท [Request Feature][issues-url] + + - - - - - - - - - +[![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] +
+[![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) +
+## โŒจ๏ธ Local Development -> ๐Ÿ“Š Total: **3** ๐Ÿ“Š Total: **3** +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)][gitpod-url] - - - - - - - - - +Or clone it for local development: +```bash +$ git clone https://github.com/lobehub/chat-plugin-sdk.git +$ cd canisminor-template +$ npm install +$ npm start +``` +
-> ๐Ÿ“Š Total: **3** + + +## ๐Ÿค Contributing + + > ๐Ÿ“Š Total: **3** - - - - - + + + + + + +
-> ๐Ÿ“Š Total: **3** ๐Ÿ“Š Total: **3** +
- - - - - - - - - +--- +#### ๐Ÿ“ License +Copyright ยฉ 2023 [LobeHub][profile-url].
+This project is [MIT](./LICENSE) licensed. -> ๐Ÿ“Š Total: **3** -> ๐Ÿ“Š Total: **3** +[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 - - - - - - - - - + +[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square + -> ๐Ÿ“Š Total: **3** +[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 - - - - - - - - - + + +[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 + + + +[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 + + + +[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-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-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-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-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