From 8e2dbddefe882f466e29a26769515382459e5f67 Mon Sep 17 00:00:00 2001
From: Robin Fidder <robin@kabisa.nl>
Date: Thu, 19 Sep 2019 09:22:13 +0200
Subject: [PATCH] Add pushEvent to docs/readme

---
 README.md                 | 15 ++++++++++++++-
 lib/phoenix_live_react.ex | 13 +++++++++++++
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ed1fa14..19e502d 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,19 @@ def render(assigns) do
 end
 ```
 
+### Events
+
+To push events back to the liveview the `pushEvent` function from Phoenix LiveView is passed as a prop
+the the component.
+
+* pushEvent(event, payload) - method to push an event from the client to the LiveView server
+
+```javascript
+const { pushEvent } = this.props;
+pushEvent("button_click");
+pushEvent("myevent", {"var": "value"});
+```
+
 ## How to add react to your phoenix app
 
 In your assets dir:
@@ -69,7 +82,7 @@ Create an `assets/.babelrc` file:
 }
 ```
 
-For NPM users, you might need the add the folloing to your `assets/webpack.config.js` file:
+For NPM users, you might need the add the following to your `assets/webpack.config.js` file:
 ```
 module.exports = (env, options) => ({
   // add:
diff --git a/lib/phoenix_live_react.ex b/lib/phoenix_live_react.ex
index 798e338..51fcba2 100644
--- a/lib/phoenix_live_react.ex
+++ b/lib/phoenix_live_react.ex
@@ -13,6 +13,19 @@ defmodule PhoenixLiveReact do
   <%= PhoenixLiveReact.live_react_component("Components.MyComponent", %{name: "Bob"}) %>
   ```
 
+  ## Events
+
+  To push events back to the liveview the `pushEvent` function from Phoenix LiveView is passed as a prop
+  the the component.
+
+  * pushEvent(event, payload) - method to push an event from the client to the LiveView server
+
+  ```
+  const { pushEvent } = this.props;
+  pushEvent("button_click");
+  pushEvent("myevent", {"var": "value"});
+  ```
+
   ## Parameters
 
     - name: String with the module name of the component