Browse Source

doc: update repo introduction

master
smallstonesk 4 years ago
parent
commit
b670192291
  1. 48
      README.md
  2. 57
      README.zh-CN.md

48
README.md

@ -1,19 +1,44 @@
# iMove # iMove
> 通过面向函数的流程可视化提高逻辑元件(ui、api)复用 <div align="center">
<center>
<img src="https://ss1.bdstatic.com/70cFuXSh_Q1YnxGkpoWK1HF6hhy/it/u=3874775950,1064987171&fm=26&gp=0.jpg" width="200px"> <img src="https://ss1.bdstatic.com/70cFuXSh_Q1YnxGkpoWK1HF6hhy/it/u=3874775950,1064987171&fm=26&gp=0.jpg" width="200px">
</center> </div>
iMove is a logic-reusable, function-oriented and process visualized JavaScript tool library.
## Features ## Features
- [x] **Process visualization:** easy to draw flow chart, logical expression is more intuitive and easy to understand
- [x] **Logic re-usage:** iMove nodes support re-using, and every node is configurable
- [x] **Flexible**: only the code is required, each iMove node is extendable and plugin can be integrated
- [ ] **Multi-language compilation**: no language compilation limitation (e.g. supports JavaScript, Java compilation)
## Get started
### Step 1. Prepare
Download this project, install dependencies and start the example.
```bash
git clone https://github.com/imgcook/imove.git
cd example
npm install
npm start
```
## Install ### Step 2. Draw a flowchart
Drag nodes from the left panel and drop them into the center to draw a flowchart.
## Usages ![flowchart](https://img.alicdn.com/tfs/TB1aoYe4pP7gK0jSZFjXXc5aXXa-3090-1806.jpg)
### Step 3. Config iMove nodes
Select node, change node's display name and completes code editing.
![flowchart-usage1](https://img.alicdn.com/tfs/TB1z6DKoZieb18jSZFvXXaI3FXa-1924-1125.png)
![flowchart-usage2](https://img.alicdn.com/tfs/TB1lC26tTM11u4jSZPxXXahcXXa-1924-1125.png)
## Contributing ## Contributing
@ -23,15 +48,10 @@
4. Push to the branch (`git push origin my-new-feature`) 4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request 5. Create new Pull Request
## 版本历史 ## Welcome fork and feedbacks
- v0.3.0 初始化版本
## 欢迎fork和反馈
如有建议或意见,请在issue提问或邮件 If you have suggestion, welcome github [issues](https://github.com/imgcook/imove/issues).
## License ## License
this repo is released under the [MIT This repo is released under the [MIT License](http://www.opensource.org/licenses/MIT).
License](http://www.opensource.org/licenses/MIT).

57
README.zh-CN.md

@ -0,0 +1,57 @@
# iMove
<div align="center">
<img src="https://ss1.bdstatic.com/70cFuXSh_Q1YnxGkpoWK1HF6hhy/it/u=3874775950,1064987171&fm=26&gp=0.jpg" width="200px">
</div>
iMove 是一个逻辑可复用的,面向函数的,流程可视化的 JavaScript 工具库。
## 特性
- [x] **流程可视化**: 上手简单,绘图方便,逻辑表达更直观,易于理解
- [x] **逻辑复用**: iMove 节点支持复用,单节点支持参数配置
- [x] **灵活可扩展**: 仅需写一个函数,节点可扩展,支持插件集成
- [ ] **多语言编译**: 无语言编译出码限制(例: 支持 JavaScript, Java 编译出码)
## 快速开始
### 步骤 1. 准备
下载仓库,安装并启动
```bash
$ git clone https://github.com/imgcook/imove.git
$ cd ./imove/example
$ npm install
$ npm start
```
### 步骤 2. 绘制流程图
从左侧拖动节点至中央画布,绘制流程图
![flowchart](https://img.alicdn.com/tfs/TB1aoYe4pP7gK0jSZFjXXc5aXXa-3090-1806.jpg)
### 步骤 3. 配置节点
选择节点,修改节点名,编辑节点代码
![flowchart-usage1](https://img.alicdn.com/tfs/TB1z6DKoZieb18jSZFvXXaI3FXa-1924-1125.png)
![flowchart-usage2](https://img.alicdn.com/tfs/TB1lC26tTM11u4jSZPxXXahcXXa-1924-1125.png)
## 贡献
1. Fork 仓库
2. 创建分支 (`git checkout -b my-new-feature`)
3. 提交修改 (`git commit -am 'Add some feature'`)
4. 推送 (`git push origin my-new-feature`)
5. 创建 PR
## 欢迎fork和反馈
如有建议或意见,欢迎在 github [issues](https://github.com/imgcook/imove/issues) 区提问
## 协议
本仓库遵循 [MIT 协议](http://www.opensource.org/licenses/MIT)
Loading…
Cancel
Save