From 3972a7e4cb31259ade4ebad1a9089724d53e96fa Mon Sep 17 00:00:00 2001 From: CanisMinor Date: Fri, 12 Apr 2024 03:55:43 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20Update=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/release.yml | 8 +- .github/workflows/test.yml | 8 +- README.md | 173 +++++++++++++++++++++++++++++++--- package.json | 6 +- 4 files changed, 172 insertions(+), 23 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f7f1a4fe..0498d7c7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -20,11 +20,11 @@ jobs: - name: Install deps run: bun i - - name: CI - run: bun run ci + - name: Link + run: bun run lint - - name: Test - run: bun run test +# - name: Test +# run: bun run test - name: Build run: bun run build diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index ceb56316..bb6ba9c3 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -17,11 +17,11 @@ jobs: - name: Install deps run: bun i - - name: CI - run: bun run ci + - name: Link + run: bun run lint - - name: Test and coverage - run: bun run test:coverage +# - name: Test and coverage +# run: bun run test:coverage - name: Upload coverage to Codecov uses: codecov/codecov-action@v4 diff --git a/README.md b/README.md index cc49c696..e03850f8 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,74 @@
-

@LobeHub/Vidol

+ + + + +# Lobe Vidol Make Virtual Idols Accessible To EveryOne! +[Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link] + +[![][github-release-shield]][github-release-link] +[![][vercel-shield]][vercel-link] +[![][discord-shield]][discord-link] +[![][github-releasedate-shield]][github-releasedate-link] +[![][github-action-test-shield]][github-action-test-link] +[![][github-action-release-shield]][github-action-release-link]
[![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link] [![][github-issues-shield]][github-issues-link] -[![][github-license-shield]][github-license-link] - -[Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link] +[![][github-license-shield]][github-license-link]
+[![][sponsor-shield]][sponsor-link] ![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png) +
+Table of contents + +#### TOC + +- [👋🏻 Getting Started & Join Our Community](#-getting-started--join-our-community) +- [✨ Features](#-features) +- [📦 Ecosystem](#-ecosystem) +- [⌨️ Local Development](#️-local-development) +- [🤝 Contributing](#-contributing) +- [🩷 Sponsor](#-sponsor) +- [🔗 Links](#-links) + - [More Products](#more-products) + - [Credits](#credits) + +#### + +
+ +
+ +## 👋🏻 Getting Started & Join Our Community + +Please be aware that LobeVidol is currently under active development, and feedback is welcome for any [issues][github-issues-link] encountered. + +| [![][vercel-shield-badge]][vercel-link] | No installation or registration necessary! Visit our website to experience it firsthand. | +| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------- | +| [![][discord-shield-badge]][discord-link] | Join our Discord community! This is where you can connect with developers and other enthusiastic users of LobeHub. | + +> \[!IMPORTANT] +> +> **Star Us**, You will receive all release notifications from GitHub without any delay \~ ⭐️ + +
Star History + + + + +
+ +
+ +[![][back-to-top]](#readme-top) +
## ✨ Features @@ -31,6 +86,25 @@ Make Virtual Idols Accessible To EveryOne! +## 📦 Ecosystem + +| NPM | Repository | Description | Version | +| --------------------------------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| [@lobehub/ui][lobe-ui-link] | [lobehub/lobe-ui][lobe-ui-github] | Open-source UI component library dedicated to building AIGC web applications. | [![][lobe-ui-shield]][lobe-ui-link] | +| [@lobehub/icons][lobe-icons-link] | [lobehub/lobe-icons][lobe-icons-github] | Popular AI / LLM Model Brand SVG Logo and Icon Collection. | [![][lobe-icons-shield]][lobe-icons-link] | +| [@lobehub/tts][lobe-tts-link] | [lobehub/lobe-tts][lobe-tts-github] | High-quality & reliable TTS/STT React Hooks library | [![][lobe-tts-shield]][lobe-tts-link] | +| [@lobehub/lint][lobe-lint-link] | [lobehub/lobe-lint][lobe-lint-github] | Configurations for ESlint, Stylelint, Commitlint, Prettier, Remark, and Semantic Release for LobeHub. | [![][lobe-lint-shield]][lobe-lint-link] | + +- **[Vidol chat market](https://github.com/v-idol/vidol-chat-agents)** - This is the Market Index of Vidol Chat. Vidol accesses index.json from this repo to show user the list of available agents. +- **[Vidol agent sample](https://github.com/v-idol/vidol-agent-sample)** - This is the sample repo to define an AI agent in Vidol. +- **[Vidol dance sample](https://github.com/v-idol/vidol-dance-sample)** - This is the sample repo to define a dance in Vidol. + +
+ +[![][back-to-top]](#readme-top) + +
+ ## ⌨️ Local Development You can use Github Codespaces for online development: @@ -60,7 +134,54 @@ Contributions of all types are more than welcome, if you are interested in contr [![][pr-welcome-shield]][pr-welcome-link] -[![][github-contrib-shield]][github-contrib-link] + + + + + + + + + + + + +
+


+
+ + + + + + + + + +
+ + + + +
+ + +
+ +[![][back-to-top]](#readme-top) + +
+ +## 🩷 Sponsor + +Every bit counts and your one-time donation sparkles in our galaxy of support! You're a shooting star, making a swift and bright impact on our journey. Thank you for believing in us – your generosity guides us toward our mission, one brilliant flash at a time. + + + + + + +
@@ -72,16 +193,16 @@ Contributions of all types are more than welcome, if you are interested in contr ### More Products -- **[Vidol chat market](https://github.com/v-idol/vidol-chat-agents)** - This is the Market Index of Vidol Chat. Vidol accesses index.json from this repo to show user the list of available agents. -- **[Vidol agent sample](https://github.com/v-idol/vidol-agent-sample)** - This is the sample repo to define an AI agent in Vidol. -- **[Vidol dance sample](https://github.com/v-idol/vidol-dance-sample)** - This is the sample repo to define a dance in Vidol. +- **[🤖 Lobe Chat][lobe-chat] :** An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application. +- **[🅰️ Lobe SD Theme][lobe-theme]:** Modern theme for Stable Diffusion WebUI, exquisite interface design, highly customizable UI, and efficiency-boosting features. +- **[⛵️ Lobe Midjourney WebUI][lobe-midjourney-webui]:** WebUI for Midjourney, leverages AI to quickly generate a wide array of rich and diverse images from text prompts, sparking creativity and enhancing conversations. +- **[🌏 Lobe i18n][lobe-i18n] :** Lobe i18n is an automation tool for the i18n (internationalization) translation process, powered by ChatGPT. It supports features such as automatic splitting of large files, incremental updates, and customization options for the OpenAI model, API proxy, and temperature. ### Credits - **mmd-parser** - - **three-vrm** - - **tts-vue** - -- **lobe-chat** -
@@ -99,10 +220,15 @@ This project is [MIT](./LICENSE) licensed. [back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square [bun-link]: https://bun.sh [bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun&style=for-the-badge +[discord-link]: https://discord.gg/AYFPHvv2jT +[discord-shield]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square +[discord-shield-badge]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge +[github-action-release-link]: https://github.com/actions/workflows/lobehub/lobe-vidol/release.yml +[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-vidol/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square +[github-action-test-link]: https://github.com/actions/workflows/lobehub/lobe-vidol/test.yml +[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-vidol/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square [github-codespace-link]: https://codespaces.new/lobehub/lobe-vidol [github-codespace-shield]: https://github.com/codespaces/badge.svg -[github-contrib-link]: https://github.com/lobehub/lobe-vidol/graphs/contributors -[github-contrib-shield]: https://contrib.rocks/image?repo=lobehub%2Fvidol.chat [github-contributors-link]: https://github.com/lobehub/lobe-vidol/graphs/contributors [github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-vidol?color=c4f042&labelColor=black&style=flat-square [github-forks-link]: https://github.com/lobehub/lobe-vidol/network/members @@ -111,8 +237,33 @@ This project is [MIT](./LICENSE) licensed. [github-issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-vidol?color=ff80eb&labelColor=black&style=flat-square [github-license-link]: https://github.com/lobehub/lobe-vidol/blob/main/LICENSE [github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-vidol?color=white&labelColor=black&style=flat-square +[github-release-link]: https://github.com/lobehub/lobe-vidol/releases +[github-release-shield]: https://img.shields.io/github/v/release/lobehub/lobe-vidol?color=369eff&labelColor=black&logo=github&style=flat-square +[github-releasedate-link]: https://github.com/lobehub/lobe-vidol/releases +[github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/lobe-vidol?labelColor=black&style=flat-square [github-stars-link]: https://github.com/lobehub/lobe-vidol/network/stargazers [github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-vidol?color=ffcb47&labelColor=black&style=flat-square +[lobe-chat]: https://github.com/lobehub/lobe-chat +[lobe-i18n]: https://github.com/lobehub/lobe-commit/tree/master/packages/lobe-i18n +[lobe-icons-github]: https://github.com/lobehub/lobe-icons +[lobe-icons-link]: https://www.npmjs.com/package/@lobehub/icons +[lobe-icons-shield]: https://img.shields.io/npm/v/@lobehub/icons?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square +[lobe-lint-github]: https://github.com/lobehub/lobe-lint +[lobe-lint-link]: https://www.npmjs.com/package/@lobehub/lint +[lobe-lint-shield]: https://img.shields.io/npm/v/@lobehub/lint?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square +[lobe-midjourney-webui]: https://github.com/lobehub/lobe-midjourney-webui +[lobe-theme]: https://github.com/lobehub/sd-webui-lobe-theme +[lobe-tts-github]: https://github.com/lobehub/lobe-tts +[lobe-tts-link]: https://www.npmjs.com/package/@lobehub/tts +[lobe-tts-shield]: https://img.shields.io/npm/v/@lobehub/tts?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square +[lobe-ui-github]: https://github.com/lobehub/lobe-ui +[lobe-ui-link]: https://www.npmjs.com/package/@lobehub/ui +[lobe-ui-shield]: https://img.shields.io/npm/v/@lobehub/ui?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square [pr-welcome-link]: https://github.com/lobehub/lobe-vidol/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 +[sponsor-link]: https://opencollective.com/lobehub 'Become 🩷 LobeHub Sponsor' +[sponsor-shield]: https://img.shields.io/badge/-Sponsor%20LobeHub-f04f88?logo=opencollective&logoColor=white&style=flat-square +[vercel-link]: https://vidol.lobehub.com +[vercel-shield]: https://img.shields.io/website?down_message=offline&label=vercel&labelColor=black&logo=vercel&style=flat-square&up_message=online&url=https%3A%2F%2Fvidol.lobehub.com +[vercel-shield-badge]: https://img.shields.io/website?down_message=offline&label=try%20lobechat&labelColor=black&logo=vercel&style=for-the-badge&up_message=online&url=https%3A%2F%2Fvidol.lobehub.com diff --git a/package.json b/package.json index 2413c4a4..372f1010 100644 --- a/package.json +++ b/package.json @@ -5,14 +5,12 @@ "description": "Make Virtual Idols Accessible To EveryOne!", "keywords": [ "framework", - "virtual-odols", + "virtual-idols", "chatbot", "chatgpt", "nextjs", "vercel-ai", "openai", - "azure-openai", - "visual-model", "tts" ], "homepage": "https://github.com/lobehub/lobe-vidol", @@ -29,7 +27,7 @@ "scripts": { "build": "next build", "dev": "next dev", - "lint": "npm run lint:ts && npm run lint:style && npm run type-check && npm run lint:circular", + "lint": "npm run lint:ts && npm run lint:style && npm run type-check", "lint:circular": "dpdm src/**/*.ts --warning false --tree false --exit-code circular:1 -T true --skip-dynamic-imports circular", "lint:md": "remark . --quiet --frail --output", "lint:style": "stylelint \"{src,tests}/**/*.{js,jsx,ts,tsx}\" --fix",