updated docs strings and added README.md

mail_intake/config.py

@@ -1,10 +1,8 @@
 """
+# Summary
+
 Global configuration models for Mail Intake.
 
----
-
-## Summary
-
 This module defines the **top-level configuration object** used to control
 mail ingestion behavior across adapters, authentication providers, and
 ingestion workflows.
@@ -20,16 +18,17 @@ from typing import Optional
 @dataclass(frozen=True)
 class MailIntakeConfig:
     """
-    Global configuration for mail-intake.
+    Global configuration for `mail-intake`.
 
     Notes:
         **Guarantees:**
 
-            - This configuration is intentionally explicit and immutable
-            - No implicit environment reads or global state
-            - Explicit configuration over implicit defaults
-            - No direct environment or filesystem access
-            - This model is safe to pass across layers and suitable for serialization
+            - This configuration is intentionally explicit and immutable.
+            - No implicit environment reads or global state.
+            - Explicit configuration over implicit defaults.
+            - No direct environment or filesystem access.
+            - This model is safe to pass across layers and suitable for
+              serialization.
     """
 
     provider: str = "gmail"