-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README.EN.md file created, English README file provided. (#3014)
* Create README.EN.md Provide English readme file. * Update README.md Provide English reference on Chinese readme file.
- Loading branch information
1 parent
f34b4ba
commit 2f9f62f
Showing
2 changed files
with
58 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 -- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters