Skip to content

Commit d0635cc

Browse files
committed
README improvements
1 parent e7f30fa commit d0635cc

File tree

2 files changed

+38
-61
lines changed

2 files changed

+38
-61
lines changed

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
11
# Kubernetes Python Client
22

33
[![Build Status](https://travis-ci.org/kubernetes-incubator/client-python.svg?branch=master)](https://travis-ci.org/kubernetes-incubator/client-python)
4+
[![PyPI version](https://badge.fury.io/py/kubernetes.svg)](https://badge.fury.io/py/kubernetes)
45

5-
Python clients for talking to a [kubernetes](http://kubernetes.io/) cluster.
6+
Python client for the [kubernetes](http://kubernetes.io/) API.
7+
8+
## Installation
9+
10+
From source:
11+
12+
```
13+
git clone https://github.com/kubernetes-incubator/client-python.git
14+
cd client-python
15+
python setup.py install
16+
```
17+
18+
From [PyPi](https://pypi.python.org/pypi/kubernetes/) directly:
19+
20+
```
21+
pip install kubernetes
22+
```
623

724
## Example
825

@@ -54,7 +71,25 @@ python -m examples.example1
5471
(replace example1 with the example base filename)
5572

5673

57-
# Generated client README
74+
## Documentation
75+
76+
All APIs and Models' documentation can be found at the [Generated client's README file](kubernetes/README.md)
77+
78+
## Community, Support, Discussion
79+
80+
You can reach the maintainers of this project at:
81+
82+
* [Slack](http://slack.kubernetes.io): #sig-api-machinery
83+
* Mailing List: [https://groups.google.com/forum/#!forum/kubernetes-sig-api-machinery](https://groups.google.com/forum/#!forum/kubernetes-sig-api-machinery)
84+
85+
If you have a problem with the package or suggestions. Please file an [issue](https://github.com/kubernetes-incubator/client-python/issues).
86+
87+
### Code of Conduct
88+
89+
Participation in the Kubernetes community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
90+
91+
## Kubernetes Incubator
5892

59-
All APIs and Models' documentation can be find at the [Generated client's README file](kubernetes/README.md)
93+
This is a [Kubernetes Incubator project](https://github.com/kubernetes/community/blob/master/incubator.md).
6094

95+
* SIG: sig-api-machinery

code-of-conduct.md

Lines changed: 0 additions & 58 deletions
This file was deleted.

0 commit comments

Comments
 (0)