From d0635ccdf3507585b098364747eb8ed9c323041c Mon Sep 17 00:00:00 2001 From: sebgoa Date: Sat, 26 Nov 2016 18:01:21 +0100 Subject: [PATCH] README improvements --- README.md | 41 +++++++++++++++++++++++++++++--- code-of-conduct.md | 58 ---------------------------------------------- 2 files changed, 38 insertions(+), 61 deletions(-) delete mode 100644 code-of-conduct.md diff --git a/README.md b/README.md index 6d9abcac2..855b24f25 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,25 @@ # Kubernetes Python Client [![Build Status](https://travis-ci.org/kubernetes-incubator/client-python.svg?branch=master)](https://travis-ci.org/kubernetes-incubator/client-python) +[![PyPI version](https://badge.fury.io/py/kubernetes.svg)](https://badge.fury.io/py/kubernetes) -Python clients for talking to a [kubernetes](http://kubernetes.io/) cluster. +Python client for the [kubernetes](http://kubernetes.io/) API. + +## Installation + +From source: + +``` +git clone https://github.com/kubernetes-incubator/client-python.git +cd client-python +python setup.py install +``` + +From [PyPi](https://pypi.python.org/pypi/kubernetes/) directly: + +``` +pip install kubernetes +``` ## Example @@ -54,7 +71,25 @@ python -m examples.example1 (replace example1 with the example base filename) -# Generated client README +## Documentation -All APIs and Models' documentation can be find at the [Generated client's README file](kubernetes/README.md) +All APIs and Models' documentation can be found at the [Generated client's README file](kubernetes/README.md) +## Community, Support, Discussion + +You can reach the maintainers of this project at: + +* [Slack](http://slack.kubernetes.io): #sig-api-machinery +* Mailing List: [https://groups.google.com/forum/#!forum/kubernetes-sig-api-machinery](https://groups.google.com/forum/#!forum/kubernetes-sig-api-machinery) + +If you have a problem with the package or suggestions. Please file an [issue](https://github.com/kubernetes-incubator/client-python/issues). + +### Code of Conduct + +Participation in the Kubernetes community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). + +## Kubernetes Incubator + +This is a [Kubernetes Incubator project](https://github.com/kubernetes/community/blob/master/incubator.md). + +* SIG: sig-api-machinery diff --git a/code-of-conduct.md b/code-of-conduct.md deleted file mode 100644 index 6453201ca..000000000 --- a/code-of-conduct.md +++ /dev/null @@ -1,58 +0,0 @@ -## Kubernetes Community Code of Conduct - -### Contributor Code of Conduct - -As contributors and maintainers of this project, and in the interest of fostering -an open and welcoming community, we pledge to respect all people who contribute -through reporting issues, posting feature requests, updating documentation, -submitting pull requests or patches, and other activities. - -We are committed to making participation in this project a harassment-free experience for -everyone, regardless of level of experience, gender, gender identity and expression, -sexual orientation, disability, personal appearance, body size, race, ethnicity, age, -religion, or nationality. - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery -* Personal attacks -* Trolling or insulting/derogatory comments -* Public or private harassment -* Publishing other's private information, such as physical or electronic addresses, - without explicit permission -* Other unethical or unprofessional conduct. - -Project maintainers have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are not -aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers -commit themselves to fairly and consistently applying these principles to every aspect -of managing this project. Project maintainers who do not follow or enforce the Code of -Conduct may be permanently removed from the project team. - -This code of conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a Kubernetes maintainer, Sarah Novotny , and/or Dan Kohn . - -This Code of Conduct is adapted from the Contributor Covenant -(http://contributor-covenant.org), version 1.2.0, available at -http://contributor-covenant.org/version/1/2/0/ - -### Kubernetes Events Code of Conduct - -Kubernetes events are working conferences intended for professional networking and collaboration in the -Kubernetes community. Attendees are expected to behave according to professional standards and in accordance -with their employer's policies on appropriate workplace behavior. - -While at Kubernetes events or related social networking opportunities, attendees should not engage in -discriminatory or offensive speech or actions regarding gender, sexuality, race, or religion. Speakers should -be especially aware of these concerns. - -The Kubernetes team does not condone any statements by speakers contrary to these standards. The Kubernetes -team reserves the right to deny entrance and/or eject from an event (without refund) any individual found to -be engaging in discriminatory or offensive speech or actions. - -Please bring any concerns to to the immediate attention of Kubernetes event staff - - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/code-of-conduct.md?pixel)]()