From d7df2b4b92e198fbdbe5cfc29095d48980675004 Mon Sep 17 00:00:00 2001
From: Jacob Sandlund
Date: Tue, 24 Jun 2025 07:55:16 -0400
Subject: Add Emoji module and codegen/emoji

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index bfa8d5e..5912ce4 100644
--- a/README.md
+++ b/README.md
@@ -520,6 +520,34 @@ test "Scripts" {
 }
 ```
 
+## Emoji
+
+To get information about emoji and emoji-like characters, use the `Emoji` module.
+
+In your `build.zig`:
+
+```zig
+exe.root_module.addImport("Emoji", zg.module("Emoji"));
+```
+
+In your code:
+
+```zig
+const Emoji = @import("Emoji");
+
+test "Emoji" {
+    const emoji = try Emoji.init(allocator);
+    defer emoji.deinit(allocator);
+
+    try expect(emoji.isEmoji(0x1F415)); // 🐕
+    try expect(emoji.isEmojiPresentation(0x1F408)); // 🐈
+    try expect(emoji.isEmojiModifier(0x1F3FF)); // 🏿
+    try expect(emoji.isEmojiModifierBase(0x1F977)); // 🥷
+    try expect(emoji.isEmojiComponent(0x1F9B0)); // 🦰
+    try expect(emoji.isExtendedPictographic(0x1F005)); // 🀅
+}
+```
+
 ## Relation to Ziglyph
 
 zg is a total re-write of some of the components of Ziglyph. The idea was to
-- 
cgit v1.2.3