Skip to content

Commit 9b07a08

Browse files
committed
doc: update README.md
1 parent f8db5d7 commit 9b07a08

File tree

1 file changed

+7
-75
lines changed

1 file changed

+7
-75
lines changed

README.md

Lines changed: 7 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,9 @@
1-
# Client Template for the Kui Graphical CLI Framework
1+
# CodeFlare Desktop Client
22

3-
[Kui](https://github.com/kubernetes-sigs/kui) is a framework for
4-
extending CLIs with graphical enhancements. If you wish to extend the
5-
framework, either by adding custom commands, custom views, or custom
6-
theming, this is the place to start!
3+
<p align="center">
4+
<img src="/plugins/plugin-client-default/icons/svg/codeflare.svg" alt="CodeFlare" width="200" height="200">
5+
</p>
76

8-
This repository offers a few silly animal-oriented commands and views,
9-
including a way to decorate Kubernetes resources with additional tabs.
10-
11-
## Getting Started with Development
12-
13-
```sh
14-
npm ci
15-
npm run watch
16-
```
17-
18-
This will spawn the Webpack watcher. Once it has finished loading, you
19-
may open a Kui window via `npm run open`. If this works, you are all
20-
set for developing your Kui-based magic.
21-
22-
## Details of the customizations in this client
23-
24-
This [wiki](https://github.com/kubernetes-sigs/kui/wiki) introduces
25-
the ways in which this application enhances Kui. In particular, this
26-
client extends Kui with:
27-
28-
<img src="docs/images/cattab.png" align="right" width="350" title="Showing the Kubernetes decorations">
29-
30-
- Decorations for Kubernetes resources: a `Cat` tab, a 🐶 button, and a 🐱 badge (shown in the upper right with a green background).
31-
32-
- A set of
33-
[commands](plugins/plugin-example/src/commands)
34-
that use Kui's built-in views. [More info](https://github.com/kubernetes-sigs/kui/wiki#approaches-for-enhancing-kui)
35-
- `hello cat` and `hello dog` are simple hello worlds that returns a cat and dog emoji, respectively
36-
- `hello sidenav` and `hello catnav` which show how to use the multi-tab "sidecar" views, with tabs on top
37-
and tabs on the left, respectively
38-
39-
<img src="docs/images/catdogwidget.gif" align="right" width="350" title="Showing the CatDogWidget StatusStripe widget">
40-
41-
- A [StatusStripe widget](plugins/plugin-example/src/view/CatDogWidget.tsx) that will be placed along the bottom of the Kui window. [More info](https://github.com/kubernetes-sigs/kui/wiki#approaches-for-enhancing-kui)
42-
43-
### More Documentation on Extending Kui
44-
45-
- [Kui Command Documentation](https://github.com/kubernetes-sigs/kui/wiki/1.-Commands) and [Terminal View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2a.-Terminal-View) uses the [string](plugins/plugin-example/src/view/string), [boolean](plugins/plugin-example/src/view/boolean), and [table](plugins/plugin-example/src/view/table) view as examples of Terminal-oriented command response.
46-
47-
- [TopNavSidecar View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2b.-TopNavSidecar-View) uses [this](plugins/plugin-example/src/view/mmr-example.ts) as an example of TopNavSidecar-oriented command response.
48-
49-
- [LeftNavSidecar View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2c.-LeftNavSidecar-View) uses [this](plugins/plugin-example/src/view/nav-example.ts) as an example of LeftNavSidecar-oriented command response.
50-
51-
## Building for Production: Electron Double-clickables
52-
53-
If you want to build and distribute your own double-clickable
54-
Electron-based clients, then use one of these commands, after which
55-
your clients will be placed in `./dist/electron`.
56-
57-
```sh
58-
npm run build:electron:all # does all of the following...
59-
npm run build:electron:mac:amd64
60-
npm run build:electron:mac:arm64
61-
npm run build:electron:linux:amd64
62-
npm run build:electron:linux:arm64
63-
npm run build:electron:windows:amd64
64-
```
65-
66-
## Building for Production: Hosted Web App
67-
68-
To build a hosted version of Kui, running in a Docker container, use
69-
this command:
70-
71-
```sh
72-
npx kui-build-docker-with-proxy
73-
```
74-
75-
This will generate a Docker image `kui-shell/kui`. To test this
76-
production web app, you can use the script `npx kui-run-cproxy`, and
77-
then visit `http://localhost:9080`.
7+
CodeFlare is a framework to simplify the integration, scaling and
8+
acceleration of complex multi-step analytics and machine learning
9+
pipelines on the cloud.

0 commit comments

Comments
 (0)