Skip to content

Commit 849770e

Browse files
committed
update readme
1 parent a7eca1b commit 849770e

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,34 @@
11
flow-platform-x
22
============
33

4-
[![LICENSE](https://img.shields.io/github/license/pingcap/tidb.svg)](https://github.com/pingcap/tidb/blob/master/LICENSE)
4+
[![LICENSE](https://img.shields.io/github/license/pingcap/tidb.svg)](https://github.com/pingcap/tidb/blob/master/LICENSE)
55

6-
A open-source continues integration server that makes CI/CD easier
6+
Powerful and user-friendly CI/CD server
77

8-
## Getting Started
8+
- Getting started within a minute   :tada:
99

10-
- [Install from docker](https://github.com/FlowCI/docker)
10+
- Simple YAML configuration and templates   :ghost:
1111

12-
- [Documentation](https://github.com/flowci/docs)
12+
- Elastic Agents to speed up build   :rocket:
1313

14-
- [YAML Templates](https://github.com/FlowCI/templates)
14+
- Online TTY to debug your job in time   :shell:
1515

16-
## Demo
16+
- Flexible plugins   :electric_plug:
1717

18-
![](https://github.com/FlowCI/docs/raw/master/src/demo.gif)
18+
- Run steps either on any docker images or native os   :computer:
19+
20+
## [Document](./en/index.md) | [中文文档](./zh/index.md)
21+
22+
## [Templates (maven, npm, golang..)](./en/index.md)
23+
24+
## Quick Start
25+
26+
> [Docker](https://docs.docker.com/install/) & [Docker-Compose](https://docs.docker.com/compose/install/) are required
27+
28+
```bash
29+
git clone https://github.com/FlowCI/docker.git flow-docker
30+
cd flow-docker
31+
./server.sh start
32+
```
33+
34+
![](./src/demo.gif)

0 commit comments

Comments
 (0)