Browse Source

docs: 更新 README

master
juzhiyuan 4 years ago
parent
commit
9c06ba50a5
  1. 38
      README.en-US.md
  2. 20
      README.md

38
README.en-US.md

@ -1,7 +1,9 @@
# iMove # iMove
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-) [![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- ALL-CONTRIBUTORS-BADGE:END -->
<div align="center"> <div align="center">
@ -14,16 +16,16 @@
[English](./README.en-US.md) | 简体中文 [English](./README.en-US.md) | 简体中文
## 特性 ## Features
- [x] **Process visualization:** iMove is easy to use and easy to draw. Its logical expression is more intuitive and easy to understand. - [x] **Process visualization:** iMove is easy to use and easy to draw. Its logical expression is more intuitive and easy to understand.
- [x] **Logic re-usage:** iMove node supports multiplexing, and its single node supports parameter configuration. - [x] **Logic re-usage:** iMove node supports multiplexing, and its single node supports parameter configuration.
- [x] **Flexible**: We need to write an only function. The node can also be extended. iMove can alse support plug-in integration. - [x] **Flexible**: We need to write an only function. The node can also be extended. iMove can alse support plug-in integration.
- [ ] **Multi-language compilation**: There is no language compiling code limitation (example: support JavaScript, Java compiling code). - [ ] **Multi-language compilation**: There is no language compiling code limitation (example: support JavaScript, Java compiling code).
## 快速开始 ## Quickstart
### 步骤 1. 准备 ### Step1. Run
Download this project, install dependencies and start the project. Download this project, install dependencies and start the project.
@ -31,15 +33,16 @@ Download this project, install dependencies and start the project.
$ git clone https://github.com/imgcook/imove.git $ git clone https://github.com/imgcook/imove.git
$ npm run example $ npm run example
``` ```
Open http://localhost:8000/ and you can see the online effect. Open http://localhost:8000/ and you can see the online effect.
### 步骤 2. 绘制流程图 ### Step2. Draw flowchart
Drag nodes from the left panel and drop them into the center, then we can get a flowchart. Drag nodes from the left panel and drop them into the center, then we can get a flowchart.
![flowchart](https://img.alicdn.com/tfs/TB1aoYe4pP7gK0jSZFjXXc5aXXa-3090-1806.jpg) ![flowchart](https://img.alicdn.com/tfs/TB1aoYe4pP7gK0jSZFjXXc5aXXa-3090-1806.jpg)
### 步骤 3. 配置节点 ### Step3. Configure nodes
Select the node, modify its display name and complete the code. Select the node, modify its display name and complete the code.
@ -47,23 +50,23 @@ Select the node, modify its display name and complete the code.
![flowchart-usage2](https://img.alicdn.com/tfs/TB1lC26tTM11u4jSZPxXXahcXXa-1924-1125.png) ![flowchart-usage2](https://img.alicdn.com/tfs/TB1lC26tTM11u4jSZPxXXahcXXa-1924-1125.png)
## 贡献 ## Contributing
1. Fork 仓库 1. Fork this repository
2. 创建分支 (`git checkout -b my-new-feature`) 2. Create a new branch (`git checkout -b my-new-feature`)
3. 提交修改 (`git commit -am 'Add some feature'`) 3. Commit your changes (`git commit -am 'Add some feature'`)
4. 推送 (`git push origin my-new-feature`) 4. Push (`git push origin my-new-feature`)
5. 创建 PR 5. File a PR
## 欢迎fork和反馈 ## Welcome to fork and feedback
If you have any suggestion, welcome to github to raise [issues](https://github.com/imgcook/imove/issues). If you have any suggestion, welcome to GitHub to raise [issues](https://github.com/imgcook/imove/issues).
## 协议 ## License
本仓库遵循 [MIT 协议](http://www.opensource.org/licenses/MIT) [MIT](http://www.opensource.org/licenses/MIT)
## 贡献者 ## Contributors
Thanks goes to these excellent ([contributors](https://allcontributors.org/docs/en/emoji-key)): Thanks goes to these excellent ([contributors](https://allcontributors.org/docs/en/emoji-key)):
@ -72,6 +75,7 @@ Thanks goes to these excellent ([contributors](https://allcontributors.org/docs/
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
<!-- markdownlint-restore --> <!-- markdownlint-restore -->
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END --> <!-- ALL-CONTRIBUTORS-LIST:END -->
本仓库遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范,欢迎贡献! This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!

20
README.md

@ -13,23 +13,22 @@
iMove 是一个逻辑可复用的,面向函数的,流程可视化的 JavaScript 工具库。 iMove 是一个逻辑可复用的,面向函数的,流程可视化的 JavaScript 工具库。
</p> </p>
[English](./README.en-US.md) | 简体中文 [English](./README.en-US.md) | 简体中文
## 特性 ## 特性
- [x] **流程可视化**: 上手简单,绘图方便,逻辑表达更直观,易于理解 - [x] **流程可视化**上手简单,绘图方便,逻辑表达更直观,易于理解
- [x] **逻辑复用**: iMove 节点支持复用,单节点支持参数配置 - [x] **逻辑复用**iMove 节点支持复用,单节点支持参数配置
- [x] **灵活可扩展**: 仅需写一个函数,节点可扩展,支持插件集成 - [x] **灵活可扩展**仅需写一个函数,节点可扩展,支持插件集成
- [ ] **多语言编译**: 无语言编译出码限制(例: 支持 JavaScript, Java 编译出码) - [ ] **多语言编译**:无语言编译出码限制(例:支持 JavaScript, Java 编译出码)
## 使用场景 ## 使用场景
![usage](https://img.alicdn.com/imgextra/i1/O1CN01kRXnfQ1LFhesOA6cn_!!6000000001270-2-tps-2212-1166.png) ![usage](https://img.alicdn.com/imgextra/i1/O1CN01kRXnfQ1LFhesOA6cn_!!6000000001270-2-tps-2212-1166.png)
1. 前端流程比如点击事件,组件生命周期回调等。 1. 前端流程比如点击事件,组件生命周期回调等。
1. 后端流程,比如Node.js或Serverless领域。 1. 后端流程:比如 Node.js 或 Serverless 领域。
1. 前端+后端,比如前端点击事件,Ajax请求和后端API。 1. 前端+后端:比如前端点击事件,Ajax 请求和后端 API。
## 快速开始 ## 快速开始
@ -43,6 +42,7 @@ $ cd imove
$ npm install $ npm install
$ npm run example $ npm run example
``` ```
此时浏览器会自动打开 `http://localhost:8000/` ,可以看到运行效果。 此时浏览器会自动打开 `http://localhost:8000/` ,可以看到运行效果。
### 步骤 2. 绘制流程图 ### 步骤 2. 绘制流程图
@ -77,7 +77,7 @@ See also the list of [contributors](https://github.com/imgcook/imove/graphs/cont
4. 推送 (`git push origin my-new-feature`) 4. 推送 (`git push origin my-new-feature`)
5. 创建 PR 5. 创建 PR
## 欢迎fork和反馈 ## 欢迎 fork 和反馈
如有建议或意见,欢迎在 github [issues](https://github.com/imgcook/imove/issues) 区提问 如有建议或意见,欢迎在 github [issues](https://github.com/imgcook/imove/issues) 区提问
@ -114,8 +114,6 @@ See also the list of [contributors](https://github.com/imgcook/imove/graphs/cont
[pr-welcoming-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square [pr-welcoming-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[pr-welcoming-url]: https://github.com/imgcook/imove/pull/new [pr-welcoming-url]: https://github.com/imgcook/imove/pull/new
## 开发者交流群 ## 开发者交流群
<img src="https://img.alicdn.com/imgextra/i3/O1CN01bXX2E41LqLLM1BZGH_!!6000000001350-2-tps-859-1184.png" width='400px'> <img src="https://img.alicdn.com/imgextra/i3/O1CN01bXX2E41LqLLM1BZGH_!!6000000001350-2-tps-859-1184.png" width='400px'>

Loading…
Cancel
Save