npm package: @lobehub/readme-wizard
Description: Generate lobe style product README by magic
Author: LobeHub
Latest version: 0.10.4

<a name="readme-top"></a>

<div align="center">

<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-logo/1.0.0/files/assets/logo-3d.webp">
<img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg">
<img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji-anim/1.0.0/files/assets/man-mage.webp">

<h1 align="center">Readme Wizard</h1>

Generate lobe style product README _by MAGIC_ \~ 🪄

[Documents](https://readme-wizard.lobehub.com) · [Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]

[![][github-release-shield]][github-release-link]
[![][vecel-shield]][vecel-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]<br/>
[![][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]

![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/268598243-0db9877a-ae3c-4250-8615-7d8b4f695169.png)

</div>

<details>
<summary><kbd>Table of contents</kbd></summary>

#### TOC

- [✨ Features](#-features)

- [⌨️ Local Development](#️-local-development)

- [🤝 Contributing](#-contributing)

- [🔗 Links](#-links)

  - [Credits](#credits)
  - [More Products](#more-products)
  - [Design Resources](#design-resources)
  - [Development Resources](#development-resources)

####

</details>

## ✨ Features

- [x] 📝 **Readme Generator**
  - [x] Hero
  - [x] Features
  - [x] Installation
  - [x] Development
  - [x] Contributing
  - [x] Credits
  - [x] License
- [x] 🔖 **Shields Generator**
  - [x] Custom
  - [x] Website
  - [x] Github
  - [x] NPM
  - [x] Vercel
  - [x] Discord
- [ ] 🌏 i18n template support
- [ ] 📦 Generator by `package.json`
- [ ] 🪄 Generator features by openAI
- [ ] ⌨️ CLI tool support

<div align="right">

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

</div>

## ⌨️ Local Development

You can use Github Codespaces for online development:

[![][codespaces-shield]][codespaces-link]

Or clone it for local development:

[![][bun-shield]][bun-link]

```bash
$ git clone https://github.com/lobehub/lobe-readme-wizard.git
$ cd lobe-readme-wizard
$ bun install
$ bun dev
```

<div align="right">

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

</div>

## 🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.

[![][pr-welcome-shield]][pr-welcome-link]

[![][github-contrib-shield]][github-contrib-link]

<div align="right">

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

</div>

## 🔗 Links

### Credits

- **recharts** - <https://github.com/recharts/recharts>
- **tremor** - <https://github.com/tremorlabs/tremor>
- **react-activity-calendar** - <https://github.com/grubersjoe/react-activity-calendar>

### More Products

- **[🤯 Lobe Chat](https://github.com/lobehub/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 Theme](https://github.com/lobehub/sd-webui-lobe-theme)** - The modern theme for stable diffusion webui, exquisite interface design, highly customizable UI, and efficiency boosting features.
- **[🧸 Lobe Vidol](https://github.com/lobehub/lobe-vidol)** - Experience the magic of virtual idol creation with Lobe Vidol, enjoy the elegance of our Exquisite UI Design, dance along using MMD Dance Support, and engage in Smooth Conversations.

### Design Resources

- **[🍭 Lobe UI](https://ui.lobehub.com)** - An open-source UI component library for building AIGC web apps.
- **[🥨 Lobe Icons](https://lobehub.com/icons)** - Popular AI / LLM Model Brand SVG Logo and Icon Collection.
- **[📊 Lobe Charts](https://charts.lobehub.com)** - React modern charts components built on recharts

### Development Resources

- **[🎤 Lobe TTS](https://tts.lobehub.com)** - A high-quality & reliable TTS/STT library for Server and Browser
- **[🌏 Lobe i18n](https://github.com/lobehub/lobe-cli-toolbox/blob/master/packages/lobe-i18n)** - Automation ai tool for the i18n (internationalization) translation process.

[More Resources](https://lobehub.com/resources)

<div align="right">

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

</div>

---

#### 📝 License

Copyright © 2023 [LobeHub][profile-link]. <br />
This project is [MIT](./LICENSE) licensed.

> _Generate by [🧙‍♂️ Readme Wizard](https://github.com/lobehub/lobe-readme-wizard 'Generate lobe style product README by MAGIC')_

<!-- LINK GROUP -->

[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
[codespaces-link]: https://codespaces.new/lobehub/lobe-readme-wizard
[codespaces-shield]: https://github.com/codespaces/badge.svg
[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
[github-action-release-link]: https://github.com/lobehub/lobe-readme-wizard/actions/workflows/release.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-readme-wizard/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/lobehub/lobe-readme-wizard/actions/workflows/test.yml
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-readme-wizard/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-contrib-link]: https://github.com/lobehub/lobe-readme-wizard/graphs/contributors
[github-contrib-shield]: https://contrib.rocks/image?repo=lobehub%2Flobe-readme-wizard
[github-contributors-link]: https://github.com/lobehub/lobe-readme-wizard/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-readme-wizard?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lobehub/lobe-readme-wizard/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-readme-wizard?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lobehub/lobe-readme-wizard/issues
[github-issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-readme-wizard?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lobehub/lobe-readme-wizard/blob/main/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-readme-wizard?color=white&labelColor=black&style=flat-square
[github-release-link]: https://github.com/lobehub/lobe-readme-wizard/releases
[github-release-shield]: https://img.shields.io/github/v/release/lobehub/lobe-readme-wizard?logo=github&color=369eff&labelColor=black&style=flat-square
[github-releasedate-link]: https://github.com/lobehub/lobe-readme-wizard/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/lobe-readme-wizard?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lobehub/lobe-readme-wizard/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-readme-wizard?color=ffcb47&labelColor=black&style=flat-square
[pr-welcome-link]: https://github.com/lobehub/lobe-chat/pulls
[pr-welcome-shield]: https://img.shields.io/badge/🤯_pr_welcome-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[profile-link]: https://github.com/lobehub
[vecel-link]: https://lobe-readme-wizard.vercel.app
[vecel-shield]: https://img.shields.io/website?down_message=offline&label=vecel&labelColor=black&logo=vercel&style=flat-square&up_message=online&url=https%3A%2F%2Flobe-readme-wizard.vercel.app