Skip to content

Commit

Permalink
docs: add README.en-US.md (#2457)
Browse files Browse the repository at this point in the history 
* docs: en readme

* chore: add readme link

* chore: add iceworks screenshot

* fix: update iceworks slogan

* chore: format the Markdown

* chore: wording change

* chore: update screenshot

* docs: fix slogan

* docs: use cdn image

* docs: optimize img size

* docs: update img

* docs: update image

* docs: update image

* docs: update img
  • Loading branch information
@imsobear
chenbin92 authored and imsobear committed Jul 15, 2019
1 parent d64121a commit d1e8571
Show file tree
Hide file tree
Showing 2 changed files with 132 additions and 10 deletions.
116 changes: 116 additions & 0 deletions README.en-US.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<p align="center">
<a href="https://ice.work">
   <img alt="ICE" src="https://img.alicdn.com/tfs/TB1gOdQRCrqK1RjSZK9XXXyypXa-192-192.png" width="96">
</a>
</p>

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

<div align="center">

Simple and friendly front-end R&D system

<a href="/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="GitHub license" /></a>
<a href="https://travis-ci.org/alibaba/ice"><img src="https://travis-ci.org/alibaba/ice.svg?branch=master" alt="Build Status" /></a>
<a href="https://github.com/alibaba/ice/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome" /></a>
<a href="https://gitter.im/alibaba/ice"><img src="https://badges.gitter.im/alibaba/ice.svg" alt="Gitter" /></a>

<div align="center">
<img src="https://img.alicdn.com/tfs/TB12869ai_1gK0jSZFqXXcpaXXa-2898-1988.png" width="1000" />
</div>
</div>

English | [简体中文](./README.md)

## Features

- :fire:**Visual Development**：Simplify front-end engineering complexity through GUI operations, while visually managing different project projects via adapters, customizing proprietary front-end workbench.
- :100:**Rich materials**：Improve project development efficiency based on material assembly while providing a wide range of React/Vue materials
- :tophat:**Best Practices**：Project development best practices based on rich experience, including directory results, development debugging, routing configuration, state management, etc.
- :whale:**Custom material**：Building Private Material System by Rapid Development of Material Developer Tools

more information [ice.work](https://ice.work).

## Quick start

We provide two ways to use iceworks for different user groups:

#### Web usage [recommend]

```bash
# Install the CLI tool
$ npm install iceworks -g

# Run iceworks
$ iceworks # Open the browser： http://127.0.0.1:8000
```

#### CLI usage

```bash
# Install the CLI tool
$ npm install iceworks -g

# New project
$ mkdir iceapp & cd iceapp

# Initialize the project with a template
$ iceworks init
```

## Ecosystem

| Project | Version | Docs | Description |
|----------------|-----------------------------------------|--------------|-----------|
| [iceworks] | [![iceworks-cli-status]][iceworks-cli-package] | [docs][iceworks-docs] |One-stop visual source code development workbench based on materials|
| [ice-devtools] | [![ice-devtools-status]][ice-devtools-package] | [docs][ice-devtools-docs] |Material development tools, support React&Vue.|
| [ice-scripts] | [![ice-scripts-status]][ice-scripts-package] | [docs][ice-scripts-docs] |Highly configurable development and build tools based on webpack|
| [icestore] | [![icestore-status]][icestore-package] | [docs][icestore-docs] |Lightweight state management solution based on React Hooks|
| [icestark] | [![icestark-status]][icestark-package] | [docs][icestark-docs] |Micro Frontends solution for large application|
| [react-materials] | / | [docs][react-materials-docs] |High quality and abundant React materials provided by the authorities|
| [vue-materials] | / | [docs][vue-materials-docs] |High quality Vue materials maintained by the community|

[iceworks]: https://github.com/alibaba/ice
[ice-devtools]: https://github.com/ice-lab/ice-devtools
[ice-scripts]: https://github.com/ice-lab/ice-scripts
[icestore]: https://github.com/ice-lab/icestore
[icestark]: https://github.com/ice-lab/icestark
[react-materials]: https://github.com/ice-lab/react-materials
[vue-materials]: https://github.com/ice-lab/vue-materials

[iceworks-cli-status]: https://img.shields.io/npm/v/iceworks-cli.svg
[ice-devtools-status]: https://img.shields.io/npm/v/ice-devtools.svg
[ice-scripts-status]: https://img.shields.io/npm/v/ice-scripts.svg
[icestore-status]: https://img.shields.io/npm/v/@ice/store.svg
[icestark-status]: https://img.shields.io/npm/v/@ice/stark.svg

[iceworks-cli-package]: https://npmjs.com/package/iceworks-cli
[ice-devtools-package]: https://npmjs.com/package/ice-devtools
[ice-scripts-package]: https://npmjs.com/package/ice-scripts
[icestore-package]: https://npmjs.com/package/@ice/store
[icestark-package]: https://npmjs.com/package/@ice/stark

[vue-materials-docs]: https://ice.work/block?type=vue
[react-materials-docs]: https://ice.work/scaffold
[iceworks-docs]: https://ice.work/docs/iceworks/about
[ice-devtools-docs]: https://ice.work/docs/materials/about
[ice-scripts-docs]: https://ice.work/docs/cli/about
[icestark-docs]: https://github.com/ice-lab/icestark#icestark
[icestore-docs]: https://github.com/ice-lab/icestore#icestore

## Contributing

Contributing Guide [CONTRIBUTING.md](/.github/CONTRIBUTING.md)

## Community

| DingTalk community | GitHub issues | Gitter |
|-------------------------------------|--------------|---------|
|<img src="https://ice.alicdn.com/assets/images/qrcode.png" width="150" /> | [issues] | [gitter]|

[issues]: https://github.com/alibaba/ice/issues
[gitter]: https://gitter.im/alibaba/ice

## License

[MIT](/LICENSE)
26 changes: 16 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,14 @@
<a href="https://github.com/alibaba/ice/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome" /></a>
<a href="https://gitter.im/alibaba/ice"><img src="https://badges.gitter.im/alibaba/ice.svg" alt="Gitter" /></a>

<div align="center">
<img src="https://img.alicdn.com/tfs/TB1kvL9aoT1gK0jSZFrXXcNCXXa-2924-1988.png" width="1000" />
</div>
</div>


[English](./README.en-US.md) | 简体中文

## 特性

- :fire:**可视化开发**：通过 GUI 操作简化前端工程复杂度，同时通过适配器可接入不同的项目工程进行可视化管理，定制专有的前端工作台
Expand All @@ -28,9 +34,9 @@

## 快速开始

为了支持不同的用户群体，我们提供了 Web 界面以及 CLI 两种使用方式，具体如下：
为了支持不同的用户群体，我们提供了 Web 界面和 CLI 两种使用方式，具体如下：

#### Web 界面使用
#### Web 界面 [推荐]

```bash
# 安装 CLI 工具
Expand All @@ -57,13 +63,13 @@ $ iceworks init

| 项目 | 版本 | 文档 | 描述 |
|----------------|-----------------------------------------|--------------|-----------|
| [iceworks] | [![iceworks-cli-status]][iceworks-cli-package] | [docs][iceworks-docs] |通过 GUI+物料提效项目开发的工具|
| [ice-devtools] | [![ice-devtools-status]][ice-devtools-package] | [docs][ice-devtools-docs] |物料开发工具|
| [ice-scripts] | [![ice-scripts-status]][ice-scripts-package] | [docs][ice-scripts-docs] |React 体系的开发调试工具|
| [icestore] | [![icestore-status]][icestore-package] | [docs][icestore-docs] |基于 React Hooks 的状态管理方案|
| [icestark] | [![icestark-status]][icestark-package] | [docs][icestark-docs] |面向大型系统的微前端解决方案|
| [react-materials] | / | [docs][react-materials-docs] |由官方维护的高质量丰富的 React 物料|
| [vue-materials] | / | [docs][vue-materials-docs] |由社区维护的高质量 Vue 物料 |
| [iceworks] | [![iceworks-cli-status]][iceworks-cli-package] | [docs][iceworks-docs] |基于物料的一站式可视化源码研发工作台|
| [ice-devtools] | [![ice-devtools-status]][ice-devtools-package] | [docs][ice-devtools-docs] |物料开发工具，支持 React&Vue|
| [ice-scripts] | [![ice-scripts-status]][ice-scripts-package] | [docs][ice-scripts-docs] |基于 webpack 的高可配置开发构建工具|
| [icestore] | [![icestore-status]][icestore-package] | [docs][icestore-docs] |基于 React Hooks 的轻量级状态管理方案|
| [icestark] | [![icestark-status]][icestark-package] | [docs][icestark-docs] |面向大型应用的微前端解决方案|
| [react-materials] | / | [docs][react-materials-docs] |由官方提供的丰富的高质量 React 物料|
| [vue-materials] | / | [docs][vue-materials-docs] |由社区维护的高质量 Vue 物料|

[iceworks]: https://github.com/alibaba/ice
[ice-devtools]: https://github.com/ice-lab/ice-devtools
Expand Down Expand Up @@ -101,7 +107,7 @@ $ iceworks init

| 钉钉群 | GitHub issues | Gitter |
|-------------------------------------|--------------|---------|
|<img src="https://ice.alicdn.com/assets/images/qrcode.png" width="200" /> | [issues] | [gitter]|
|<img src="https://ice.alicdn.com/assets/images/qrcode.png" width="150" /> | [issues] | [gitter]|

[issues]: https://github.com/alibaba/ice/issues
[gitter]: https://gitter.im/alibaba/ice
Expand Down

0 comments on commit d1e8571

Please # to comment.