88
99A high-quality & reliable TTS React Hooks library
1010
11- [ ![ ] [ github -release-shield]] [ github -release-link]
11+ [ ![ ] [ npm -release-shield]] [ npm -release-link]
1212[ ![ ] [ github-releasedate-shield ]] [ github-releasedate-link ]
1313[ ![ ] [ github-action-test-shield ]] [ github-action-test-link ]
1414[ ![ ] [ github-action-release-shield ]] [ github-action-release-link ] <br />
@@ -24,6 +24,53 @@ A high-quality & reliable TTS React Hooks library
2424
2525</div >
2626
27+ <details >
28+ <summary ><kbd >Table of contents</kbd ></summary >
29+
30+ #### TOC
31+
32+ - [ 📦 Installation] ( #-installation )
33+ - [ Compile with Next.js] ( #compile-with-nextjs )
34+ - [ 🛳 Self Hosting] ( #-self-hosting )
35+ - [ Deploy to Vercel] ( #deploy-to-vercel )
36+ - [ ⌨️ Local Development] ( #️-local-development )
37+ - [ 🤝 Contributing] ( #-contributing )
38+ - [ 🔗 More Products] ( #-more-products )
39+
40+ ####
41+
42+ </details >
43+
44+ ## 📦 Installation
45+
46+ > ** Important** \
47+ > This package is [ ESM only] ( https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c ) .
48+
49+ To install ` @lobehub/tts ` , run the following command:
50+
51+ [ ![ ] [ bun-shield ]] [ bun-link ]
52+
53+ ``` bash
54+ $ bun add @lobehub/tts
55+ ```
56+
57+ ### Compile with Next.js
58+
59+ > ** Note** \
60+ > By work correct with Next.js SSR, add ` transpilePackages: ['@lobehub/tts'] ` to ` next.config.js ` . For example:
61+
62+ ``` js
63+ const nextConfig = {
64+ transpilePackages: [' @lobehub/tts' ],
65+ };
66+ ```
67+
68+ <div align =" right " >
69+
70+ [ ![ ] [ back-to-top ]] ( #readme-top )
71+
72+ </div >
73+
2774## 🛳 Self Hosting
2875
2976If you want to deploy this service by yourself, you can follow the steps below.
@@ -48,8 +95,6 @@ You can use Github Codespaces for online development:
4895
4996Or clone it for local development:
5097
51- [ ![ ] [ bun-shield ]] [ bun-link ]
52-
5398``` bash
5499$ git clone https://github.com/lobehub/lobe-tts.git
55100$ cd lobe-tts
@@ -114,12 +159,12 @@ This project is [MIT](./LICENSE) licensed.
114159[ github-issues-shield ] : https://img.shields.io/github/issues/lobehub/lobe-tts?color=ff80eb&labelColor=black&style=flat-square
115160[ github-license-link ] : https://github.com/lobehub/lobe-tts/blob/main/LICENSE
116161[ github-license-shield ] : https://img.shields.io/github/license/lobehub/lobe-tts?color=white&labelColor=black&style=flat-square
117- [ github-release-link ] : https://github.com/lobehub/lobe-tts/releases
118- [ github-release-shield ] : https://img.shields.io/github/v/release/lobehub/lobe-tts?color=369eff&labelColor=black&logo=github&style=flat-square
119162[ github-releasedate-link ] : https://github.com/lobehub/lobe-tts/releases
120163[ github-releasedate-shield ] : https://img.shields.io/github/release-date/lobehub/lobe-tts?labelColor=black&style=flat-square
121164[ github-stars-link ] : https://github.com/lobehub/lobe-tts/network/stargazers
122165[ github-stars-shield ] : https://img.shields.io/github/stars/lobehub/lobe-tts?color=ffcb47&labelColor=black&style=flat-square
166+ [ npm-release-link ] : https://www.npmjs.com/package/@lobehub/tts
167+ [ npm-release-shield ] : https://img.shields.io/npm/v/@lobehub/tts?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square
123168[ pr-welcome-link ] : https://github.com/lobehub/lobe-tts/pulls
124169[ pr-welcome-shield ] : https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
125170[ profile-link ] : https://github.com/lobehub
0 commit comments