Skip to content

Commit 4b0b105

Browse files
authored
Update Readme with the latest GIF and content (#1223)
1 parent 8487e96 commit 4b0b105

File tree

7 files changed

+16
-39
lines changed

7 files changed

+16
-39
lines changed

README.md

+16-34
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
Botkube is a messaging bot for monitoring and debugging Kubernetes clusters.
99
</p>
1010

11-
1211
<p align="center">
1312
<a href="https://github.com/kubeshop/botkube/releases/latest">
1413
<img src="https://img.shields.io/github/v/release/kubeshop/botkube" alt="Latest Release" />
@@ -31,59 +30,42 @@
3130

3231
Botkube helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources. It integrates with multiple communication platforms, such as [Slack](https://slack.com), [Discord](https://discord.com/), or [Mattermost](https://mattermost.com).
3332

34-
You can also execute `kubectl` commands on K8s cluster via Botkube which helps debugging an application or cluster.
33+
You can also execute `kubectl`, `helm` and other commands on your K8s, which helps debugging an application or cluster.
3534

3635
<p align="center">
3736
<img src="./docs/assets/main-demo.gif" />
3837
</p>
3938

4039
## Getting started
4140

42-
Please follow [this](https://docs.botkube.io/installation/) for a complete Botkube installation guide.
43-
44-
## Documentation
45-
46-
For full documentation, visit [botkube.io](https://docs.botkube.io). The documentation sources reside on the [botkube-docs](https://github.com/kubeshop/botkube-docs) repository under **content** directory.
41+
Follow [the official Botkube installation guide](https://docs.botkube.io/installation/) to get started.
4742

4843
## Features
4944

50-
<img src="./docs/assets/icons/terminal-box-line.svg" width="12%" align="right"/>
51-
52-
### Execute `kubectl` commands
53-
54-
The same `kubectl` capabilities inside your favorite communicator. You do not have to learn anything new! Plus, you can configure which `kubectl` commands Botkube can execute. See [configuration](https://docs.botkube.io/configuration/) for details.
55-
56-
<br /><br />
45+
### 💬 Connect to your clusters from anywhere at any time
5746

58-
<img src="./docs/assets/icons/question-answer-line.svg" width="10%" align="left"/>
47+
Botkube intergrates with all common messaging platforms including:
5948

60-
### Use multiple communication platforms
49+
- Teams
50+
- Slack
51+
- Discord
52+
- Mattermost
6153

62-
Botkube integrates with Slack, Discord, Mattermost, Microsoft Teams, ElasticSearch and outgoing webhook. See [configuration](https://docs.botkube.io/configuration/communication/) syntax for details.
54+
### 💡 Elevate your troubleshooting workflow with intelligent insights
6355

64-
<br /><br />
56+
Supercharge your technical workflow with our seamless alert consolidation and filtering. Gain automated intelligent insights to troubleshoot with precision and efficiency. Get alerted by Kubernetes, Prometheus, and other tools.
6557

66-
<img src="./docs/assets/icons/stack-line.svg" width="13%" align="right"/>
58+
### 🚀 See alerts, Take action
6759

68-
### Monitor any Kubernetes resource
60+
Take your ChatOps experience to new heights and go beyond just monitoring. Seamlessly take action on your clusters with ease and efficiency. Access tools like `kubectl` and `helm` right from your collaboration workspace. Collaborate with other team members in real time.
6961

70-
Botkube supports literally any Kubernetes resource, including Custom Resources. For example, if you use [`cert-manager`](https://cert-manager.io/), you can get alerted about certificate issue, or backup failure in case you use backup tools like [Velero](https://velero.io/) or [Kanister](https://kanister.io/).
62+
### 📖 Wait, there's more!
7163

72-
<br /><br />
64+
Read more about Botkube features on [the official website](https://botkube.io/features/).
7365

74-
<img src="./docs/assets/icons/bug-line.svg" width="12%" align="left"/>
75-
76-
### Debug anywhere, anytime
77-
78-
Using Botkube you can debug your apps deployed on Kubernetes from anywhere. To extract crucial information from the cluster, you can even use mobile communicator apps, like Slack. The entire team can see what steps have already been taken and avoid duplicated work.
79-
80-
<br /><br />
81-
82-
<img src="./docs/assets/icons/cloud-line.svg" width="12%" align="right"/>
83-
84-
### Deploy on any Kubernetes cluster
66+
## Documentation
8567

86-
You can deploy Botkube backend on any Kubernetes cluster. It doesn't matter whether it is [K3d](https://k3d.io), managed Kubernetes on a cloud provider, or bare-metal one.
68+
For full documentation, visit [docs,botkube.io](https://docs.botkube.io). The documentation sources reside on the [botkube-docs](https://github.com/kubeshop/botkube-docs) repository.
8769

8870
## Licence
8971

docs/assets/icons/bug-line.svg

-1
This file was deleted.

docs/assets/icons/cloud-line.svg

-1
This file was deleted.

docs/assets/icons/question-answer-line.svg

-1
This file was deleted.

docs/assets/icons/stack-line.svg

-1
This file was deleted.

docs/assets/icons/terminal-box-line.svg

-1
This file was deleted.

docs/assets/main-demo.gif

265 KB
Loading

0 commit comments

Comments
 (0)