Skip to content

Commit

Permalink
README.EN.md file created, English README file provided. (#3014)
Browse files Browse the repository at this point in the history
* Create README.EN.md

Provide English readme file.

* Update README.md

Provide English reference on Chinese readme file.
  • Loading branch information
bathiatuss authored Oct 30, 2024
1 parent f34b4ba commit 2f9f62f
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 1 deletion.
55 changes: 55 additions & 0 deletions README.EN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<div align="center">

[![HiUI Logo](https://raw.githubusercontent.com/XiaoMi/hiui/stable/3.x/site/static/img/logo.png)](https://xiaomi.github.io/hiui/)

<h1 align="center">HiUI</h1>

![JavaScript Style Guide](https://avatars.githubusercontent.com/u/29208316?s=48&v=4)

</div>

---

**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 --
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@

<h1 align="center">HiUI</h1>

[![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)

</div>

---
|简体中文|[ENGLISH](README.EN.md)|
---

HiUI 是一个面向中后台系统的前端组件库,可以帮助开发人员快速实现交互一致、界面美观的界面开发。
Expand Down

0 comments on commit 2f9f62f

Please sign in to comment.