Skip to content

Commit

Permalink
📝 docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arvinxx committed Nov 18, 2023
1 parent 4e3e996 commit 46e1639
Showing 1 changed file with 1 addition and 28 deletions.
29 changes: 1 addition & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,9 @@ A high-quality & reliable TTS library

#### TOC

- [📦 Usage](#-usage)
- [📦 Installation](#-installation)
- [Compile with Next.js](#compile-with-nextjs)
- [🛳 Self Hosting](#-self-hosting)
- [Deploy to Vercel](#deploy-to-vercel)
- [Environment Variable](#environment-variable)
- [⌨️ Local Development](#️-local-development)
- [🤝 Contributing](#-contributing)
- [🔗 More Products](#-more-products)
Expand Down Expand Up @@ -148,31 +146,6 @@ const nextConfig = {

</div>

## 🛳 Self Hosting

If you want to deploy this service by yourself, you can follow the steps below.

### Deploy to Vercel

Click button below to deploy your private plugins' gateway.

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-tts&project-name=lobe-tts&repository-name=lobe-tts)

### Environment Variable

This project provides some additional configuration items set with environment variables:

| Environment Variable | Description | Default |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `OPENAI_API_KEY` | This is the API key you apply on the OpenAI account page | `sk-xxxxxx...xxxxxx` |
| `OPENAI_BASE_URL` | If you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URL | `https://api.openai.com/v1` |

<div align="right">

[![][back-to-top]](#readme-top)

</div>

## ⌨️ Local Development

You can use Github Codespaces for online development:
Expand Down

0 comments on commit 46e1639

Please sign in to comment.