From 1b20ae951b7f59d0d1f60c5d9a3d6bcf547cbcc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Atakan=20Baltac=C4=B1?= <67705822+bathiatuss@users.noreply.github.com> Date: Wed, 9 Oct 2024 01:54:32 +0300 Subject: [PATCH 1/2] Create README.EN.md Provide English readme file. --- README.EN.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.EN.md diff --git a/README.EN.md b/README.EN.md new file mode 100644 index 000000000..b71d7e669 --- /dev/null +++ b/README.EN.md @@ -0,0 +1,55 @@ +
+ +[![HiUI Logo](https://raw.githubusercontent.com/XiaoMi/hiui/stable/3.x/site/static/img/logo.png)](https://xiaomi.github.io/hiui/) + +

HiUI

+ +![JavaScript Style Guide](https://avatars.githubusercontent.com/u/29208316?s=48&v=4) + +
+ +--- + +**HiUI** is a frontend component library designed for middle and back-end systems, helping developers quickly create interfaces that are visually appealing and consistent in interaction. + +### Features + +- Focused on the interaction and visual design of middle and back-end products. +- Comprehensive templates for processes and data display, tailored from business needs, covering most requirements of middle and back-end systems with templates and components. +- Component design with a data structure separation, easy to learn and upgrade, ready to use out of the box. + +### Installation + +Install and import **HiUI** from `npm`. + +#### Full Installation + +```bash +npm config set registry https://registry.npmjs.org + +npm install @hi-ui/core @hi-ui/hiui +``` + +#### On-Demand Installation + +```bash +npm config set registry https://registry.npmjs.org + +npm install @hi-ui/core @hi-ui/component-name +``` + +> **Note**: Please use lowercase for the component name and separate words with hyphens. + +### Usage + +For detailed component usage, refer to the [official documentation](https://xiaomi.github.io/hiui/docs/quick-start). + +### Contribution + +For contributions to **HiUI**, see the [contribution guidelines](https://github.com/XiaoMi/hiui/blob/master/CONTRIBUTING.md). + +### License + +MIT + +-- EOF -- From ab75528c0d9e7c309937b29fee4861a5e0003181 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Atakan=20Baltac=C4=B1?= <67705822+bathiatuss@users.noreply.github.com> Date: Wed, 9 Oct 2024 02:00:51 +0300 Subject: [PATCH 2/2] Update README.md Provide English reference on Chinese readme file. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4f55b6314..7c3e599d9 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,12 @@

HiUI

-[![JavaScript Style Guide](https://camo.githubusercontent.com/58fbab8bb63d069c1e4fb3fa37c2899c38ffcd18/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d7374616e646172642d627269676874677265656e2e737667)](https://github.com/standard/standard) +![JavaScript Style Guide](https://avatars.githubusercontent.com/u/29208316?s=48&v=4) +--- +|简体中文|[ENGLISH](README.EN.md)| --- HiUI 是一个面向中后台系统的前端组件库,可以帮助开发人员快速实现交互一致、界面美观的界面开发。