Skip to content

Commit 8776135

Browse files
committed
Update README.md
Signed-off-by: yutao04 <[email protected]>
0 parents  commit 8776135

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Api Plane
2+
[![Hango gateway CI](https://github.com/hango-io/api-plane/actions/workflows/java_ci.yml/badge.svg)](https://github.com/hango-io/api-plane/actions/workflows/java_ci.yml)
3+
4+
## About
5+
Generate Slime CRD and Istio CRD for gateway,include VirtualService, DestinationRule, EnvoyPlugin, etc...
6+
VirtualService and DestinationRule are Istio CRD, which is used to route.
7+
EnvoyPlugin and PluginManager are Slime CRD,which is used for plugin configuration.
8+
9+
## Project structure
10+
```shell script
11+
.
12+
├── plugin
13+
└── hango-api-plane-server
14+
├── Dockerfile
15+
├── src
16+
├── setenv.sh
17+
└── pom.xml
18+
├── LICENSE
19+
├── README.md
20+
└── pom.xml
21+
22+
````
23+
24+
## Develop
25+
Using maven
26+
```shell script
27+
$ git clone [email protected]:hango-io/api-plane.git
28+
$ cd hango-api-plane-server
29+
$ mvn clean package
30+
```
31+
32+
## Contributing
33+
If you wish to contribute to Hango API Gateway, please read the root projects' contributing files.
34+
35+
## License
36+
[Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)

0 commit comments

Comments
 (0)