From a88b4928cc28b81505f92778f0c0ff7f84361a1c Mon Sep 17 00:00:00 2001 From: Sagi Date: Wed, 19 Oct 2022 20:31:37 +0800 Subject: [PATCH] docs: update readme.md and readme.en.md --- README.en.md | 24 ++++++++++++------------ README.md | 26 +++++++++++++------------- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/README.en.md b/README.en.md index abf460b92b..b761b4d852 100644 --- a/README.en.md +++ b/README.en.md @@ -5,15 +5,15 @@

-

Farris UI Vue

+

Farris Vue

-

Farris UI Vue, a Farris Design based Vue3 component library.

+

Farris Vue, a Farris Design based Vue3 component library.

English | [Simplified Chinese](README.md) Farris Design Priciples： -- Fast :Farris UI, composed by UI suites with super-fast user experience. Farris Data Grid, with high-speed rendering performance when rendering huge amounts of data. +- Fast :Farris Vue, composed by UI suites with super-fast user experience. Farris Data Grid, with high-speed rendering performance when rendering huge amounts of data. - Reliable: Provide users with steady and reliable use embodiment and optimize various abnormal interaction scenarios targeted. - Responsive: Enhanced responsive design, provides more nuanced responsive interactions inside components. - Intuitive: Intuitive design, enables users to have an intuitive interface interaction experience. @@ -62,7 +62,7 @@ Open browser to review the sample page：`http://localhost:5173/`。 You can visit the sample site： -1. Click「quick start」to learn how to install and use Farris UI Vue. +1. Click「quick start」to learn how to install and use Farris Vue. 2. Click「components」to experience component visual effects and interaction effects, and view the component API documentation simultaneously. ## 3. Guide to Use Farris UI Vue @@ -77,7 +77,7 @@ npm install @farris/ui-vue yarn add @farris/ui-vue ``` -### 3.2 Import Farris UI Vue +### 3.2 Import Farris Vue Locate your `main.ts` document and import `@farris/ui-vue` into the Application. @@ -89,9 +89,9 @@ import Farris from '@farris/ui-vue'; createApp(App).use(Farris).mount('#app'); ``` -### 3.3 Use Farris UI Vue +### 3.3 Use Farris Vue -Once imported, you can attempt to use Farris UI Vue components. Locate to the `App.vue` document and have a try! +Once imported, you can attempt to use Farris Vue components. Locate to the `App.vue` document and have a try! ```vue ``` -## 4. How to Be a Farris UI Vue Contributor +## 4. How to Be a Farris Vue Contributor -Contribute to Farris UI Vue. +Contribute to Farris Vue. You can participate in the following contributions: - Develop Farris Vue Components with `TypeScript` + `TSX` + `SystemJs` + `Rollup` technologies -- Contribute to the Farris UI Theme tool -- Contribute to the Farris UI development documentation +- Contribute to the Farris Theme tool +- Contribute to the Farris development documentation If you decide to contribute to Farris UI Vue，you could start from reading our [Contributor guide](./CONTRIBUTING.md). ## ✨ Contributors -Thanks to the following Farris UI Vue contributors. +Thanks to the following Farris Vue contributors.