From 4dd48dd2ac58822d0c38662c5559adac60497559 Mon Sep 17 00:00:00 2001
From: Josh McKinney <joshka@users.noreply.github.com>
Date: Sat, 13 Jan 2024 00:02:45 -0800
Subject: [PATCH] fix: readme

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 2077fe3..2c8295d 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ This is an experimental playground for us to explore macros that would be useful
 - Constraint-based Layouts: Easily define layout constraints such as fixed, percentage, minimum, and
   maximum sizes, as well as ratios.
 - Directional Layouts: Specify layouts as either horizontal or vertical with simple macro commands.
+- Raw and Styled span format macros.
 
 ## Getting Started
 
@@ -33,6 +34,8 @@ use ratatui_macros::{
     constraints,
     horizontal,
     vertical,
+    raw,
+    styled,
 };
 ```
 
@@ -112,6 +115,23 @@ assert_eq!(left.width, 3);
 assert_eq!(right.width, 3);
 ```
 
+## Spans
+
+The `raw!` and `styled!` macros create raw and styled `Span`s respectively. They each take a format
+string and arguments. `styled!` accepts as the first paramter any value that can be converted to a
+`Style`.
+
+```rust
+use ratatui::prelude::*
+use ratatui_macros::{styled, raw};
+
+let name = "world!";
+let raw_greeting = raw!("hello {name}");
+let styled_greeting = styled!(Style::new().green(), "hello {name}");
+let styled_greeting = styled!(Color::Green, "hello {name}");
+let styled_greeting = styled!(Modifier::BOLD, "hello {name}");
+```
+
 ## Contributing
 
 Contributions to `ratatui-macros` are welcome! Whether it's submitting a bug report, a feature