updated docs strings and added README.md

omniread/html/__init__.py

@@ -1,31 +1,31 @@
 """
+# Summary
+
 HTML format implementation for OmniRead.
 
----
-
-## Summary
-
 This package provides **HTML-specific implementations** of the core OmniRead
 contracts defined in `omniread.core`.
 
 It includes:
-- HTML parsers that interpret HTML content
-- HTML scrapers that retrieve HTML documents
 
-This package:
-- Implements, but does not redefine, core contracts
-- May contain HTML-specific behavior and edge-case handling
-- Produces canonical content models defined in `omniread.core.content`
+- HTML parsers that interpret HTML content.
+- HTML scrapers that retrieve HTML documents.
+
+Key characteristics:
+
+- Implements, but does not redefine, core contracts.
+- May contain HTML-specific behavior and edge-case handling.
+- Produces canonical content models defined in `omniread.core.content`.
 
 Consumers should depend on `omniread.core` interfaces wherever possible and
 use this package only when HTML-specific behavior is required.
 
 ---
 
-## Public API
+# Public API
 
-    HTMLScraper
-    HTMLParser
+- `HTMLScraper`
+- `HTMLParser`
 
 ---
 """