From d17598a630809fd35e49cf317037de9d61e13a8d Mon Sep 17 00:00:00 2001
From: Dor Shtaif <dorshtaif@gmail.com>
Date: Mon, 23 Dec 2024 17:02:39 +0200
Subject: [PATCH] initial part of `README.md`

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e70f370..d03edd7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,17 @@
-# react-async-iterators
+# React Async Iterators
+
+> Hooks, components and utilities for working with [JS async iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncIterator) data in React.js.
+
+<br />
+
+<p>
+  <a href="https://github.com/shtaif/react-async-iterators/actions/workflows/ci-tests.yaml">
+    <img alt="" src="https://github.com/shtaif/react-async-iterators/actions/workflows/ci-tests.yaml/badge.svg" />
+  </a>
+  <a href="https://github.com/shtaif/react-async-iterators/actions/workflows/ci-build-check.yaml">
+    <img alt="" src="https://github.com/shtaif/react-async-iterators/actions/workflows/ci-build-check.yaml/badge.svg" />
+  </a>
+  <a href="https://semver.org">
+    <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" />
+  </a>
+<p>