diff --git a/README.md b/README.md index 6ccb811..0ef2d8b 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ -# 🥝 Kiwi - Extensible Real-Time Data Streaming +
+drawing +

Kiwi - Extensible Real-Time Data Streaming

[![test](https://github.com/rkrishn7/kiwi/actions/workflows/test.yml/badge.svg)](https://github.com/rkrishn7/kiwi/actions/workflows/test.yml) [![check](https://github.com/rkrishn7/kiwi/actions/workflows/check.yml/badge.svg)](https://github.com/rkrishn7/kiwi/actions/workflows/check.yml) [![CircleCI](https://dl.circleci.com/status-badge/img/gh/rkrishn7/kiwi/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/rkrishn7/kiwi/tree/main) ![contributions](https://img.shields.io/badge/contributions-welcome-green) +
Kiwi is a WebSocket adapter for real-time data sources. It implements a simple protocol for clients to subscribe to configured sources, while allowing operators to maintain control over the flow of data via [WebAssembly](https://webassembly.org/) (WASM) plugins. Kiwi is designed to be a lightweight, extensible, and secure solution for delivering real-time data to clients, ensuring that they stay reactive and up-to-date with the latest data. -- [🥝 Kiwi - Extensible Real-Time Data Streaming](#-kiwi---extensible-real-time-data-streaming) - - [Features](#features) - - [Motivation](#motivation) - - [Getting Started](#getting-started) - - [Plugins](#plugins) - - [Sources](#sources) - - [Kafka](#kafka) - - [Counter](#counter) - - [Protocol](#protocol) - - [Configuration](#configuration) - - [Considerations](#considerations) +- [Features](#features) +- [Motivation](#motivation) +- [Getting Started](#getting-started) +- [Plugins](#plugins) +- [Sources](#sources) + - [Kafka](#kafka) + - [Counter](#counter) +- [Protocol](#protocol) +- [Configuration](#configuration) +- [Considerations](#considerations) ## Features diff --git a/assets/kiwi-bird.png b/assets/kiwi-bird.png new file mode 100644 index 0000000..9d0cacd Binary files /dev/null and b/assets/kiwi-bird.png differ