From 4ee0b9c003aa1ccd52c8c7118b5204eceee358e4 Mon Sep 17 00:00:00 2001 From: arvinxx Date: Wed, 23 Aug 2023 00:06:37 +0800 Subject: [PATCH] :memo: docs: update documents --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f445aab..b7c21cd 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,11 @@ Plugin Gateway Service for Lobe Chat and Lobe Web #### TOC -- [📦 Installation](#-installation) +- [👋 Intro](#-introduction) - [🤯 Usage](#-usage) +- +- [🛳 Self Hosting](#-self-hosting) - [⌨️ Local Development](#️-local-development) @@ -45,6 +47,12 @@ Plugin Gateway Service for Lobe Chat and Lobe Web +## 👋 Intro + +LobeChat Plugins Gateway is a backend service that provides a gateway for LobeChat plugins. We use [vercel](https://vercel.com/) to deploy this service. The main API `POST /api/v1/runner` is deployed as an [Edge Function](https://vercel.com/docs/functions/edge-functions). + +The gateway service fetches lobe plugins index from the [LobeChat Plugins](https://github.com/lobehub/lobe-chat-plugins), if you want to add your plugin to the index, please [submit a PR](https://github.com/lobehub/lobe-chat-plugins/pulls) to the LobeChat Plugins repository. + ## 🤯 Usage Base URLs: @@ -148,6 +156,12 @@ See [API Document](https://apifox.com/apidoc/shared-c574e77f-4230-4727-9c05-c5c9 +## 🛳 Self Hosting + +If you want to deploy this service by yourself, you can follow the steps below. + +TO_BE_DONE... + ## ⌨️ Local Development You can use Gitpod for online development: