summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorfisherxu <xufei40@huawei.com>2020-03-03 09:51:35 +0800
committerfisherxu <xufei40@huawei.com>2020-03-03 10:28:53 +0800
commit18d1c173032755ae7bf70c7bff63dee3976d4d21 (patch)
treecc58bf0bf73a85a4ba7c39b04e689043acf25ed2 /README.md
parentMerge pull request #1507 from zhuguihua/set_concurrent_consumers_as_variable (diff)
downloadkubeedge-18d1c173032755ae7bf70c7bff63dee3976d4d21.tar.gz
Separated documents by users and developers
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 16 insertions, 9 deletions
diff --git a/README.md b/README.md
index 473c8f0ea..fab85013f 100644
--- a/README.md
+++ b/README.md
@@ -76,10 +76,19 @@ Key:
| KubeEdge 1.2 | ✗ | ✗ | ✓ | ✓ |
| KubeEdge HEAD (master) | ✗ | ✗ | ✓ | ✓ |
-## Usage
-* [Install KubeEdge](./docs/setup/kubeedge_install.md)
-* [Configure KubeEdge](./docs/setup/kubeedge_configure.md)
-* [Deploy Application and Run Tests](./docs/setup/kubeedge_precheck.md)
+## Guides
+
+### User Guide
+
+See our documentation on [kubeedge.io](https://kubeedge.io).
+
+Quick Start - Install KubeEdge with [keadm](./docs/setup/kubeedge_install_keadm.md).
+
+Try some examples of KubeEdge on [examples](https://github.com/kubeedge/examples).
+
+### Developer Guide
+
+Take a look at our [development guide], If you are interested in building and contributing KubeEdge.
## Roadmap
@@ -99,11 +108,6 @@ Resources:
- [Meeting link](https://zoom.us/j/4167237304)
- [Meeting Calendar](https://calendar.google.com/calendar/embed?src=8rjk8o516vfte21qibvlae3lj4%40group.calendar.google.com) | [Subscribe](https://calendar.google.com/calendar?cid=OHJqazhvNTE2dmZ0ZTIxcWlidmxhZTNsajRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ)
-## Documentation
-
-The detailed documentation for KubeEdge and its modules can be found at [https://docs.kubeedge.io](https://docs.kubeedge.io).
-Some sample applications and demos to illustrate possible use cases of KubeEdge platform can be found at this [examples](https://github.com/kubeedge/examples) repository.
-
## Contact
<!--
@@ -126,3 +130,6 @@ details on submitting patches and the contribution workflow.
## License
KubeEdge is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.
+
+
+[development guide]: ./docs/setup/develop_kubeedge.md