Skip to content

Commit 5ba482c

Browse files
committed
Update READMEs
1 parent 4a1a63b commit 5ba482c

File tree

5 files changed

+33
-6
lines changed

5 files changed

+33
-6
lines changed

README.cjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
// call with `node <this-file> <template-file`
22
const nunjucks = require('nunjucks')
3-
console.log(nunjucks.render(process.argv[2]))
3+
console.log(nunjucks.render(process.argv[2]).trim())

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# kubernetes-client-browser
2-
Kubernetes client implementation for the browser
1+
# Kubernetes Client
2+
3+
Query Kubernetes API from the browser.
4+
Ideal for SPA-like apps and CRDs.
5+
6+
This repository is a monorepo that is the home of multiple npm packages.
7+
8+
Supports:
9+
* Angular
10+
* Vanilla JavaScript with Fetch API
11+
12+
Check out the other packages with concrete implementations:
13+
14+
* [@nxt-engineering/kubernetes-client-fetch](https://www.npmjs.com/package/@nxt-engineering/kubernetes-client-fetch): Uses the Browser's native Fetch API.
15+
* [@nxt-engineering/kubernetes-client-angular](https://www.npmjs.com/package/@nxt-engineering/kubernetes-client-angular): Made for Angular framework with NGRX state management.
16+
17+
## Development
18+
19+
Structure:
20+
```
21+
packages/
22+
kubernetes-client/ # Core package
23+
kubernetes-client-fetch/ # Implementation with Fetch API
24+
kubernetes-client-example-fetch/ # Client with Fetch API in action
25+
kubernetes-client-angular/ # Client example and library for Angular 16
26+
eslint-config-custom/ # Common linting configuration
27+
```
28+
29+
* `npm run build`: Builds all packages
30+
* `npm run lint`: Lints and formats all packages
31+
* `npm run e2e`: Run all e2e tests for the example packages
32+
* `npm run test`: Run unit tests for packages

packages/kubernetes-client-angular/projects/kubernetes-client-angular/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,4 +195,3 @@ Other than that, this package follows SemVer.
195195

196196
There is an official [Kubernetes client](https://github.com/kubernetes-client/javascript).
197197
However, it's not yet ready for browsers and development seems a bit slow.
198-

packages/kubernetes-client-fetch/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,4 +143,3 @@ Other than that, this package follows SemVer.
143143

144144
There is an official [Kubernetes client](https://github.com/kubernetes-client/javascript).
145145
However, it's not yet ready for browsers and development seems a bit slow.
146-

packages/kubernetes-client/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,3 @@ Check out the other packages with concrete implementations:
99

1010
* [@nxt-engineering/kubernetes-client-fetch](https://www.npmjs.com/package/@nxt-engineering/kubernetes-client-fetch): Uses the Browser's native Fetch API.
1111
* [@nxt-engineering/kubernetes-client-angular](https://www.npmjs.com/package/@nxt-engineering/kubernetes-client-angular): Made for Angular framework with NGRX state management.
12-

0 commit comments

Comments
 (0)