updated docs strings and added README.md

openapi_first/client.py

@@ -1,10 +1,8 @@
 """
+# Summary
+
 OpenAPI-first HTTP client for contract-driven services.
 
----
-
-## Summary
-
 This module provides `OpenAPIClient`, a thin, strict HTTP client that
 derives all callable operations directly from an OpenAPI 3.x specification.
 
@@ -49,20 +47,22 @@ class OpenAPIClientError(OpenAPIFirstError):
 
 class OpenAPIClient:
     """
-    OpenAPI-first HTTP client (httpx-based).
+    OpenAPI-first HTTP client (`httpx`-based).
 
     Notes:
         **Responsibilities:**
 
-            - This client derives all callable methods directly from an OpenAPI 3.x specification. Each operationId becomes a method on the client instance.
+            - This client derives all callable methods directly from an
+              OpenAPI 3.x specification. Each `operationId` becomes a method
+              on the client instance.
 
         **Guarantees:**
 
-            - One callable per operationId
-            - Explicit parameters (path, query, headers, body)
-            - No implicit schema inference or mutation
-            - Returns raw `httpx.Response` objects
-            - No response validation or deserialization
+            - One callable per `operationId`.
+            - Explicit parameters (path, query, headers, body).
+            - No implicit schema inference or mutation.
+            - Returns raw `httpx.Response` objects.
+            - No response validation or deserialization.
 
     Example:
         ```python