Skip to content

Commit b893d23

Browse files
committed
docs(readme): update readme with image and contributing section
1 parent fc814be commit b893d23

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# html_highlight
22

3+
<img align="right" width="300" alt="highlight" src="https://github.com/user-attachments/assets/6e6db63b-53b3-44eb-95e9-34e470ca39f0" />
4+
35
html_highlight solves the challenge of adding persistent text highlights to HTML content in Flutter applications. Unlike simple string-based approaches that break on complex HTML, this package parses HTML into a DOM tree, manipulates it safely, and serializes it back—ensuring highlights work correctly across paragraphs, lists, blockquotes, and nested elements.
46

57
The engine is idempotent (safe to apply multiple times), deterministic (same input always produces the same output), and uses a multi-strategy resolution system to locate highlights even when document content changes slightly.
@@ -102,3 +104,6 @@ The engine caches text maps for performance. Clear caches when content changes:
102104
HighlightEngine.clearCache('article-123'); // Specific article
103105
HighlightEngine.clearAllCache(); // All cached maps
104106
```
107+
108+
## Contributing
109+
For information regarding contributions, please refer to [CONTRIBUTING.md](CONTRIBUTING.md) file.

0 commit comments

Comments
 (0)