diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..ad8b7261b7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# 开发贡献参考 + +详情见文档 [开发贡献](https://docs.yunion.io/contribute/) diff --git a/README.md b/README.md index 59216abf89..71a2a85a5e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,36 @@ [![Build Status](https://travis-ci.com/yunionio/onecloud.svg?branch=master)](https://travis-ci.org/yunionio/onecloud) [![Go Report Card](https://goreportcard.com/badge/github.com/yunionio/onecloud)](https://goreportcard.com/report/github.com/yunionio/onecloud) -# 文档 +## 什么是 OneCloud? -- 文档中心,https://docs.yunion.cn/ -- API文档,https://docs.yunion.cn/api/ +OneCloud 是一个开源的多云管理平台,具备以下特性: + +- 统一全面 + + 统一API、镜像、调度、账号体系、监控和计费等操作,能够全面管理 On premises、 私有云、公有云资源。 + +- 内置私有云 + + OneCloud 本身就提供完备的私有云实现,提供虚拟机、物理机、容器和负载均衡等资源管理。 + +## 部署 + +请参考文档 [安装部署](https://docs.yunion.io/setup/) 搭建 OneCloud 集群。 + +## 文档 + +- [文档中心](https://docs.yunion.io/) + +- [Swagger API文档](https://docs.yunion.cn/api/) + +## 架构 + +![architecture](./docs/architecture.png) + +## 贡献 + +我们非常欢迎和感谢开发者向项目做贡献,流程细节请查看 [CONTRIBUTING.md](./CONTRIBUTING.md) 。 + +## License + +OneCloud 使用 Apache 2.0 license. 详情请看 [LICENSE](./LICENSE) 。 diff --git a/docs/architecture.png b/docs/architecture.png new file mode 100644 index 0000000000..4b75758a8c Binary files /dev/null and b/docs/architecture.png differ