Skip to content

Commit

Permalink
📝 docs: update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
arvinxx committed Aug 22, 2023
1 parent 4d8029d commit 4ee0b9c
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -45,6 +47,12 @@ Plugin Gateway Service for Lobe Chat and Lobe Web

</details>

## 👋 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:
Expand Down Expand Up @@ -148,6 +156,12 @@ See [API Document](https://apifox.com/apidoc/shared-c574e77f-4230-4727-9c05-c5c9

</div>

## 🛳 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:
Expand Down

0 comments on commit 4ee0b9c

Please sign in to comment.