From 151caacd9d1675174a035731429058eea20ea5c9 Mon Sep 17 00:00:00 2001
From: Philipp Reiter <p.reiter93@gmail.con>
Date: Sun, 13 Oct 2024 10:35:09 +0200
Subject: [PATCH] Update README

---
 README.md  | 18 +++++++++++++++++-
 src/lib.rs | 18 +++++++++++++++++-
 2 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e4857a1..ce06ce4 100644
--- a/README.md
+++ b/README.md
@@ -10,8 +10,9 @@
 `EdTUI` is a text editor widget for the [Ratatui](https://github.com/ratatui-org/ratatui) ecosystem.
 It is designed to provide a light-weight user experience inspired by Vim.
 
+Instantiate the state and render the view:
 ```rust
-use edtui::{EditorState, EditorTheme, EditorView};
+use edtui::{EditorEventHandler, EditorState, EditorTheme, EditorView};
 use ratatui::widgets::Widget;
 
 let mut state = EditorState::default();
@@ -19,6 +20,21 @@ EditorView::new(&mut state)
         .theme(EditorTheme::default())
         .wrap(true) // line wrapping
         .render(area, buf);
+
+```
+
+Handle events:
+```rust
+let mut event_handler = EditorEventHandler::default();
+
+// or handle only key events
+event_handler.on_key_event(key_event, &mut state);
+
+// has experimental support for mouse events
+event_handler.on_mouse_event(mouse_event, &mut state);
+
+// handles both key and mouse events
+event_handler.on_event(event, &mut state);
 ```
 
 ### Features
diff --git a/src/lib.rs b/src/lib.rs
index 7f3fb78..de4b36f 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -10,8 +10,9 @@
 //! `EdTUI` is a text editor widget for the [Ratatui](https://github.com/ratatui-org/ratatui) ecosystem.
 //! It is designed to provide a light-weight user experience inspired by Vim.
 //!
+//! Instantiate the state and render the view:
 //! ```ignore
-//! use edtui::{EditorState, EditorTheme, EditorView};
+//! use edtui::{EditorEventHandler, EditorState, EditorTheme, EditorView};
 //! use ratatui::widgets::Widget;
 //!
 //! let mut state = EditorState::default();
@@ -19,6 +20,21 @@
 //!         .theme(EditorTheme::default())
 //!         .wrap(true) // line wrapping
 //!         .render(area, buf);
+//!
+//! ```
+//!
+//! Handle events:
+//! ```ignore
+//! let mut event_handler = EditorEventHandler::default();
+//!
+//! // or handle only key events
+//! event_handler.on_key_event(key_event, &mut state);
+//!
+//! // has experimental support for mouse events
+//! event_handler.on_mouse_event(mouse_event, &mut state);
+//!
+//! // handles both key and mouse events
+//! event_handler.on_event(event, &mut state);
 //! ```
 //!
 //! ## Features