From 98ae5eec99d37528994d2d32f5f935f4b9d24484 Mon Sep 17 00:00:00 2001
From: Pablo Neves Machado <pablo.nevesmachado@elastic.co>
Date: Tue, 13 Dec 2022 16:19:29 +0100
Subject: [PATCH] Add Readme file to ui-action component

---
 .../ui_actions/public/cell_actions/README.md    | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 src/plugins/ui_actions/public/cell_actions/README.md

diff --git a/src/plugins/ui_actions/public/cell_actions/README.md b/src/plugins/ui_actions/public/cell_actions/README.md
new file mode 100644
index 000000000000000..aca9ee7082ad5fb
--- /dev/null
+++ b/src/plugins/ui_actions/public/cell_actions/README.md
@@ -0,0 +1,17 @@
+This package provides a uniform interface for displaying UI actions for a cell.
+For the `CellActions` component to work, it must be wrapped by `CellActionsContextProvider`. Ideally, the wrapper should stay on the top of the rendering tree.
+
+Example:
+```JSX
+<CellActionsContextProvider
+    // call uiActions.getTriggerCompatibleActions(triggerId, data)
+    getCompatibleActions={getCompatibleActions}>
+    ...
+    <CellActions mode={CellActionsMode.HOVER_POPOVER} triggerId={MY_TRIGGER_ID} config={{ field: 'fieldName', value: 'fieldValue', fieldType: 'text' }}>
+        Hover me
+    </CellActions>
+</CellActionsContextProvider>
+
+```
+
+`CellActions` component will display all compatible actions registered for the trigger id.
\ No newline at end of file