Skip to content

Commit c0bb77d

Browse files
committed
doc: update README
1 parent 9f57277 commit c0bb77d

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,17 @@
66
[![Volkswagen](https://auchenberg.github.io/volkswagen/volkswargen_ci.svg?v=1)](https://github.com/auchenberg/volkswagen)
77
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
88

9-
An event bridge for applications and services build on an event mesh with a team-oriented self-service control plane.
9+
An event bridge for applications and services build on top of [NATS.io](https://nats.io) and [Knative Eventing/Serving](https://knative.dev/docs/).
1010

1111
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/ZEISS/typhoon?quickstart=1)
1212

13-
## Design
13+
## Why
14+
15+
[AWS EventBridge](https://aws.amazon.com/eventbridge/) is a great service to bridge events between different sources and targets in your enterprise. However, it is not a cloud-native solution and it is not open-source.
1416

15-
Every software system has design goals. Properties that it should provide io its users to create value. Typhoon has the following design goals:
17+
It is the goal to create a cloud-native and open-source alternative that works on-premise and in the cloud and that has a focus on enterprise-readyness.
18+
19+
## Design
1620

1721
* **Event mesh**. The system is capable to route events from producers to consumers in hybrid cloud environemts.
1822
* **Streaming**. The system is capable to stream events from producers to consumers. That means it is capable of replaying events not only queueing them.
@@ -53,23 +57,23 @@ The accounting should be done via the [Operator for NATS Accounting](https://gi
5357
```shell
5458
helm repo add typhoon https://zeiss.github.io/typhoon
5559
helm repo update
56-
helm search typhoon
60+
helm search repo typhoon
5761
```
5862

59-
Install Typhoon to your cluster in a `typhoon` namespace.
63+
Install Typhoon to your cluster and wait for the deployment to finish.
6064

6165
```shell
62-
helm install typhoon typhoon/typhoon --create-namespace --namespace typhoon
66+
helm install typhoon typhoon/typhoon --wait
6367
```
6468

6569
## Prerequisites
6670

6771
* Kubernetes `v1.28` or newer
68-
* Knative Eventing `v1.15` or newer
69-
* Knative Serving `v1.15` or newer
72+
* Knative Eventing `v1.16` or newer
73+
* Knative Serving `v1.16` or newer
7074
* Helm `3.0` or newer
7175

72-
The prerequisites can be installed via the [ZEISS Charts](https://github.com/ZEISS/charts).
76+
The prerequisites can be installed via the [ZEISS Charts](https://github.com/zeiss/charts).
7377

7478
## Installation
7579

0 commit comments

Comments
 (0)