From b920b6b4514d5259b13ac2f25f6891454aaf4fdb Mon Sep 17 00:00:00 2001 From: mbohlool Date: Fri, 9 Jun 2017 15:19:24 -0700 Subject: [PATCH] Update README file --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4251d23d7..f9a15b72b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # python-base -# This repo is for testing new client library structure +This is the utility part of the [python client](https://github.com/kubernetes-incubator/client-python). It has been added to the main +repo using git submodules. This structure allow other developers to create +their own kubernetes client and still use standard kubernetes python utilities. +For more information refer to [clients-library-structure](https://github.com/kubernetes-client/community/blob/master/design-docs/clients-library-structure.md). + +# Development +Any changes to utilites in this repo should be send as a PR to this repo. After +the PR is merged, developers should create another PR in the main repo to update +the submodule. See [this document](https://github.com/kubernetes-incubator/client-python/blob/master/devel/submodules.md) for more guidelines. \ No newline at end of file