Skip to content

Commit 67586a4

Browse files
committed
updates README w/ relevant info
1 parent 2ab4052 commit 67586a4

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Build Status](https://github.com/kubernetes-client/javascript/workflows/Kubernetes%20Javascript%20Client%20-%20Validation/badge.svg)](https://github.com/kubernetes-client/javascript/actions)
44
[![Client Capabilities](https://img.shields.io/badge/Kubernetes%20client-Gold-blue.svg?style=flat&colorB=FFD700&colorA=306CE8)](http://bit.ly/kubernetes-client-capabilities-badge)
55
[![Client Support Level](https://img.shields.io/badge/kubernetes%20client-beta-green.svg?style=flat&colorA=306CE8)](http://bit.ly/kubernetes-client-support-badge)
6+
[![Build and Deploy Docs](https://github.com/kubernetes-client/javascript/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/kubernetes-client/javascript/actions/workflows/deploy-docs.yml)
67

78
The Javascript clients for Kubernetes is implemented in
89
[typescript](https://typescriptlang.org), but can be called from either
@@ -99,9 +100,14 @@ const k8sApi = kc.makeApiClient(k8s.CoreV1Api);
99100
...
100101
```
101102

102-
# Additional Examples
103+
# Additional Examples and Documentation
103104

104-
There are several more examples in the [examples](https://github.com/kubernetes-client/javascript/tree/master/examples) directory.
105+
There are several more JS and TS examples in the [examples](https://github.com/kubernetes-client/javascript/tree/master/examples) directory.
106+
107+
Documentation for the library is split into two resources:
108+
109+
1. The [Kubernetes API Reference](https://kubernetes.io/docs/reference/) is the source-of-truth for all Kubernetes client libraries, including this one. We suggest starting here!
110+
2. The Typedoc autogenerated docs can be viewed [online](https://kubernetes-client.github.io/javascript) and can also be built locally (see below)
105111

106112
# Compatibility
107113

0 commit comments

Comments
 (0)