From 15f2309e324a390dfe584398694e5019bbb8af77 Mon Sep 17 00:00:00 2001
From: Siddharth Thevaril <siddharth.thevaril@gmail.com>
Date: Mon, 29 Jan 2024 19:50:34 +0530
Subject: [PATCH] clarify usage of `<Repeater />` component

---
 components/repeater/readme.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/components/repeater/readme.md b/components/repeater/readme.md
index 949be97c..8ed267b5 100644
--- a/components/repeater/readme.md
+++ b/components/repeater/readme.md
@@ -11,15 +11,32 @@ A Repeater component that allows you to add repeater fields.
 
 The type definition of the attribute needs to be set as an array and the name of the attribute should be passed to the `attribute` prop of the `Repeater` component.
 
+For example, if a repeater item unit is a group field containing a text field and a checkbox field, the attribute would be defined in `block.json` as:
+
+```json```
+"attributes": {
+    "repeaterFieldData": {
+        "type": "array",
+        "default": [
+            {
+                text: '',
+                checked: false
+            }
+        ],
+    }
+}
+
+**Note:** You should not provide an `id` to the repeater item unit. The Repeater component will automatically generate an `id` for each item.
+
 ```js
 import { Repeater } from '@10up/block-components';
 
 export function BlockEdit(props) {
     const { attributes } = props;
-    const { items } = attributes;
+    const { repeaterFieldData } = attributes;
 
     return (
-        <Repeater attribute="items">
+        <Repeater attribute="repeaterFieldData">
             {( item, index, setItem, removeItem ) => (
                 <>
                     <TextControl key={index} value={item} onChange={(value) => setItem(value)} />