✨ feat: Bump 1.0.0

lobehub · Nov 7, 2023 · 9ce0f91 · 9ce0f91
1 parent 8031da1
commit 9ce0f91
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 280 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,54 +1,3 @@
 <a name="readme-top"></a>
 
 # Changelog
-
-## Version 1.0.0
-
-<sup>Released on **2023-11-07**</sup>
-
-#### ✨ Features
-
-- **misc**: Add new files, import modules, configure themes, and update API endpoints, Init.
-
-<br/>
-
-<details>
-<summary><kbd>Improvements and Fixes</kbd></summary>
-
-#### What's improved
-
-- **misc**: Add new files, import modules, configure themes, and update API endpoints ([9930472](https://github.com/lobehub/lobe-tts/commit/9930472))
-- **misc**: Init ([9961d3a](https://github.com/lobehub/lobe-tts/commit/9961d3a))
-
-</details>
-
-<div align="right">
-
-[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
-
-</div>
-
-## Version 1.0.0
-
-<sup>Released on **2023-11-02**</sup>
-
-#### ✨ Features
-
-- **misc**: Init.
-
-<br/>
-
-<details>
-<summary><kbd>Improvements and Fixes</kbd></summary>
-
-#### What's improved
-
-- **misc**: Init ([9961d3a](https://github.com/lobehub/lobe-tts/commit/9961d3a))
-
-</details>
-
-<div align="right">
-
-[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
-
-</div>
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 A high-quality & reliable TTS React Hooks library
 
-[![][github-release-shield]][github-release-link]
+[![][npm-release-shield]][npm-release-link]
 [![][github-releasedate-shield]][github-releasedate-link]
 [![][github-action-test-shield]][github-action-test-link]
 [![][github-action-release-shield]][github-action-release-link]<br/>
@@ -24,6 +24,53 @@ A high-quality & reliable TTS React Hooks library
 
 </div>
 
+<details>
+<summary><kbd>Table of contents</kbd></summary>
+
+#### TOC
+
+- [📦 Installation](#-installation)
+  - [Compile with Next.js](#compile-with-nextjs)
+- [🛳 Self Hosting](#-self-hosting)
+  - [Deploy to Vercel](#deploy-to-vercel)
+- [⌨️ Local Development](#️-local-development)
+- [🤝 Contributing](#-contributing)
+- [🔗 More Products](#-more-products)
+
+####
+
+</details>
+
+## 📦 Installation
+
+> **Important**\
+> This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+
+To install `@lobehub/tts`, run the following command:
+
+[![][bun-shield]][bun-link]
+
+```bash
+$ bun add @lobehub/tts
+```
+
+### Compile with Next.js
+
+> **Note**\
+> By work correct with Next.js SSR, add `transpilePackages: ['@lobehub/tts']` to `next.config.js`. For example:
+
+```js
+const nextConfig = {
+  transpilePackages: ['@lobehub/tts'],
+};
+```
+
+<div align="right">
+
+[![][back-to-top]](#readme-top)
+
+</div>
+
 ## 🛳 Self Hosting
 
 If 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:
 
 Or clone it for local development:
 
-[![][bun-shield]][bun-link]
-
 ```bash
 $ git clone https://github.com/lobehub/lobe-tts.git
 $ cd lobe-tts
@@ -114,12 +159,12 @@ This project is [MIT](./LICENSE) licensed.
 [github-issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-tts?color=ff80eb&labelColor=black&style=flat-square
 [github-license-link]: https://github.com/lobehub/lobe-tts/blob/main/LICENSE
 [github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-tts?color=white&labelColor=black&style=flat-square
-[github-release-link]: https://github.com/lobehub/lobe-tts/releases
-[github-release-shield]: https://img.shields.io/github/v/release/lobehub/lobe-tts?color=369eff&labelColor=black&logo=github&style=flat-square
 [github-releasedate-link]: https://github.com/lobehub/lobe-tts/releases
 [github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/lobe-tts?labelColor=black&style=flat-square
 [github-stars-link]: https://github.com/lobehub/lobe-tts/network/stargazers
 [github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-tts?color=ffcb47&labelColor=black&style=flat-square
+[npm-release-link]: https://www.npmjs.com/package/@lobehub/tts
+[npm-release-shield]: https://img.shields.io/npm/v/@lobehub/tts?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square
 [pr-welcome-link]: https://github.com/lobehub/lobe-tts/pulls
 [pr-welcome-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
 [profile-link]: https://github.com/lobehub
diff --git a/api/cors.ts b/api/cors.ts
diff --git a/api/genSSML.ts b/api/genSSML.ts
diff --git a/api/index.ts b/api/index.ts
@@ -1,8 +1,8 @@
 import qs from 'query-string';
 
-import cors from './cors';
-import { SsmlOptions } from './genSSML';
-import { postMicrosoftSpeech } from './postMicrosoftSpeech';
+import cors from '../lib/cors';
+import { SsmlOptions } from '../lib/genSSML';
+import { postMicrosoftSpeech } from '../lib/postMicrosoftSpeech';
 
 export const config = {
   runtime: 'edge',

diff --git a/api/postMicrosoftSpeech.ts b/api/postMicrosoftSpeech.ts
diff --git a/package.json b/package.json
@@ -1,7 +1,6 @@
 {
   "name": "@lobehub/tts",
   "version": "1.0.0",
-  "private": true,
   "description": "A high-quality & reliable TTS React Hooks library",
   "homepage": "https://github.com/lobehub/lobe-tts",
   "bugs": {

diff --git a/tsconfig.json b/tsconfig.json
@@ -30,5 +30,5 @@
       }
     ]
   },
-  "include": ["src", "docs", ".dumirc.ts", "api", "**/*.ts", "**/*.d.ts", "**/*.tsx"]
+  "include": ["src", "docs", "lib", ".dumirc.ts", "api", "**/*.ts", "**/*.d.ts", "**/*.tsx"]
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -30,5 +30,5 @@ @@
           }
         ]
       },
-      "include": ["src", "docs", ".dumirc.ts", "api", "**/*.ts", "**/*.d.ts", "**/*.tsx"]
+      "include": ["src", "docs", "lib", ".dumirc.ts", "api", "**/*.ts", "**/*.d.ts", "**/*.tsx"]
     }