From 45523fa08ec0322885f0f6149a5d68df0283b193 Mon Sep 17 00:00:00 2001
From: Alex Clarke <alex.j.tusa@gmail.com>
Date: Mon, 18 Nov 2024 14:46:19 -0700
Subject: [PATCH] chore: Updated the README to have more detailed instructions
 on how to use the widget

---
 Cargo.toml |  6 +++--
 README.md  | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 71 insertions(+), 3 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index fc96617..955a354 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -4,13 +4,15 @@ description = "Tree Widget for Managarr"
 version = "0.24.0"
 license = "MIT"
 repository = "https://github.com/Dark-Alex-17/managarr-tree-widget"
-authors = ["EdJoPaTo <tui-tree-widget-rust-crate@edjopato.de>", "Dark-Alex-17 <alex.j.tusa@gmail.com>"]
+authors = [
+  "EdJoPaTo <tui-tree-widget-rust-crate@edjopato.de>",
+  "Dark-Alex-17 <alex.j.tusa@gmail.com>",
+]
 edition = "2021"
 keywords = ["tui", "terminal", "tree", "widget", "managarr"]
 categories = ["command-line-interface"]
 rust-version = "1.82.0"
 include = ["src/**/*", "examples/**/*", "benches/**/*", "README.md"]
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [lints.rust]
 unsafe_code = "forbid"
diff --git a/README.md b/README.md
index 9366530..2473210 100644
--- a/README.md
+++ b/README.md
@@ -8,10 +8,76 @@
 Add this widget to your project using the following command: 
 
 ```shell
-cargo add --git 'https://github.com/Dark-Alex-17/managarr-tree-widget.git'
+cargo add managarr-tree-widget
 ```
 
+## Running the example
+To run the example widget, simply run:
+
+```shell
+cargo run --example example
+```
+
+## Usage
+The following is an example of how to create a tree of strings (namely one like the one used in the [example](./examples/example.rs)):
+
+```rust
+fn draw(&mut self, frame: &mut Frame) {
+    let area = frame.area();
+    let tree_items = vec![
+        TreeItem::new_leaf("Alfa"),
+        TreeItem::new(
+            "Bravo",
+            vec![
+                TreeItem::new_leaf("Charlie"),
+                TreeItem::new(
+                    "Delta",
+                    vec![TreeItem::new_leaf("Echo"), TreeItem::new_leaf("Foxtrot")],
+                )
+                .expect("all item identifiers are unique"),
+                TreeItem::new_leaf("Golf"),
+            ],
+        )
+        .expect("all item identifiers are unique"),
+        TreeItem::new_leaf("Hotel"),
+    ];
+    let widget = Tree::new(&tree_items)
+        .expect("all item identifiers are unique")
+        .block(
+            Block::bordered()
+                .title("Tree Widget"),
+        )
+        .highlight_style(
+            Style::new()
+                .fg(Color::Black)
+                .bg(Color::LightGreen)
+                .add_modifier(Modifier::BOLD),
+        )
+        .highlight_symbol(">> ");
+    frame.render_stateful_widget(widget, area, &mut self.state);
+}
+```
+
+This will generate the following tree structure:
+
+```
+┌── Alfa
+├── Bravo
+│   ├── Charlie
+│   ├── Delta
+│   │ ├── Echo
+│   │ └── Foxtrot
+│   └── Golf
+└── Hotel
+```
+
+This example assumes the existence of a `self.state` field that is initialized with `TreeState::default()`. The `TreeItem` struct is used to create a tree of items, and the `Tree` struct is used to create the widget itself.
+
+A more detailed and feature-complete example is available in the [example](./examples/example.rs) file.
 
 ## Credit
 The original project for this widget is the [Ratatui Tree Widget](https://github.com/EdJoPaTo/tui-rs-tree-widget), which was purpose built for the specific use
 case of [`mqttui`](https://github.com/EdJoPaTo/mqttui).
+
+The updated version of the tree widget that allows more generic types is created by me, [Alex Clarke](https://github.com/Dark-Alex-17).
+