Skip to content

Commit

Permalink
Merge pull request #45 from VisActor/doc/readme_add_npminfo
Browse files Browse the repository at this point in the history
docs: add npm info to readme
  • Loading branch information
da730 authored Mar 26, 2024
2 parents 7b84a49 + a95cd48 commit 8c924f5
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,49 @@
# @visactor/vmind

<div align="center">
<a href="https://github.com/VisActor#gh-light-mode-only" target="_blank">
<img alt="VisActor Logo" width="200" src="https://github.com/VisActor/.github/blob/main/profile/logo_500_200_light.svg"/>
</a>
<a href="https://github.com/VisActor#gh-dark-mode-only" target="_blank">
<img alt="VisActor Logo" width="200" src="https://github.com/VisActor/.github/blob/main/profile/logo_500_200_dark.svg"/>
</a>
</div>

<div align="center">
<h1>VMind</h1>
</div>

<div align="center">

Not just automatic, but also fantastic.Open-source solution for intelligent visualization.

<p align="center">
<a href="https://www.visactor.io/vmind">Introduction</a> •
<a href="https://www.visactor.io/vmind/example">Demo</a> •
<a href="https://www.visactor.io/vmind/guide/Intro_to_VMind">Tutorial</a> •
<a href="https://www.visactor.io/vmind/api/VMind_Instance">API</a>•
<a href="https://www.visactor.io/vmind/openapi">OpenApi</a>
</p>

![](https://github.com/visactor/vmind/actions/workflows/bug-server.yml/badge.svg)
![](https://github.com/visactor/vmind/actions/workflows/unit-test.yml/badge.svg)
[![npm Version](https://img.shields.io/npm/v/@visactor/vmind.svg)](https://www.npmjs.com/package/@visactor/vmind)
[![npm Download](https://img.shields.io/npm/dm/@visactor/vmind.svg)](https://www.npmjs.com/package/@visactor/vmind)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/VisActor/VMind/blob/main/CONTRIBUTING.md#your-first-pull-request)

![](https://img.shields.io/badge/language-TypeScript-red.svg) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/visactor/vmind/blob/main/LICENSE)

</div>



<div align="center">

English | [简体中文](readme-zh.md)

</div>

## 简介

`@visactor/vmind` is an intelligent chart component based on LLM provided by [VisActor](https://www.visactor.io/), including dialog-based chart generation and editing capabilities. It provides a natural language interaction interface, allowing you to easily create chart narrative works with `@visactor/VMind` with just one sentence, and edit them through continuous dialogue, greatly improving your efficiency in creating data visualization works.

The main features of `@visactor/vmind` include:
Expand Down
25 changes: 25 additions & 0 deletions readme-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,31 @@

</div>


<div align="center">

不仅自动,还很智能.开源智能可视化解决方案.

<p align="center">
<a href="https://www.visactor.io/vmind">Introduction</a> •
<a href="https://www.visactor.io/vmind/example">Demo</a> •
<a href="https://www.visactor.io/vmind/guide/Intro_to_VMind">Tutorial</a> •
<a href="https://www.visactor.io/vmind/api/VMind_Instance">API</a>•
<a href="https://www.visactor.io/vmind/openapi">OpenApi</a>
</p>

![](https://github.com/visactor/vmind/actions/workflows/bug-server.yml/badge.svg)
![](https://github.com/visactor/vmind/actions/workflows/unit-test.yml/badge.svg)
[![npm Version](https://img.shields.io/npm/v/@visactor/vmind.svg)](https://www.npmjs.com/package/@visactor/vmind)
[![npm Download](https://img.shields.io/npm/dm/@visactor/vmind.svg)](https://www.npmjs.com/package/@visactor/vmind)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/VisActor/VMind/blob/main/CONTRIBUTING.md#your-first-pull-request)

![](https://img.shields.io/badge/language-TypeScript-red.svg) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/visactor/vmind/blob/main/LICENSE)

</div>

## 简介

`@visactor/vmind` 是由 [VisActor](https://www.visactor.io/) 为您提供的基于大模型的图表智能组件,包括对话式的图表智能生成与编辑能力。它提供了一个自然语言交互接口,仅需一句话,您就能够轻松使用`@visactor/vmind` 创建图表叙事作品,并通过连续的对话进行编辑,极大地提高您创作数据可视化作品的效率。

`@visactor/vmind` 的主要特点包括:
Expand Down

0 comments on commit 8c924f5

Please sign in to comment.