feat: add readme for polywrap-client-config-builder

Author: Niraj-Kamdar

packages/polywrap-client-config-builder/README.md

@@ -1,14 +1,64 @@
+# polywrap-client-config-builder
 
-# Polywrap Python Client
-## This object allows you to build proper Polywrapt ClientConfig objects
+A utility class for building the PolywrapClient config. 
 
-These objects are needed to configure your python client's wrappers, pluggins, env variables, resolvers and interfaces.
+Supports building configs using method chaining or imperatively.
 
-Look at [this file](./polywrap_client_config_builder/client_config_builder.py) to detail all of its functionality
-And at [tests](./tests/test_client_config_builder.py)
+## Quickstart
 
----
+### Initialize
 
-The current implementation uses the `ClientConfig` as a dataclass to later create an Abstract Base Class of a `BaseClientConfigBuilder` which defines more clearly the functions of the module, like add_envs, set_resolvers, remove_wrappers, and so on.  
+Initialize a ClientConfigBuilder using the constructor
 
-This `BaseClientConfigBuilder` is later used in the class `ClientConfigBuilder` which only implements the build method, for now, and inherits all the abstract methods of the `BaseClientConfigBuilder`.
+```python
+# start with a blank slate (typical usage)
+builder = ClientConfigBuilder()
+```
+
+### Configure
+
+Add client configuration with add, or flexibly mix and match builder configuration methods to add and remove configuration items.
+
+```python
+# add multiple items to the configuration using the catch-all `add` method
+builder.add(
+    BuilderConfig(
+        envs={},
+        interfaces={},
+        redirects={},
+        wrappers={},
+        packages={},
+        resolvers=[]
+    )
+)
+
+// add or remove items by chaining method calls
+builder
+    .add_package("wrap://plugin/package", test_plugin({}))
+    .remove_package("wrap://plugin/package")
+    .add_packages(
+      {
+        "wrap://plugin/http": http_plugin({}),
+        "wrap://plugin/filesystem": file_system_plugin({}),
+      }
+    )
+```
+
+### Build
+
+Finally, build a ClientConfig to pass to the PolywrapClient constructor.
+
+```python
+# accepted by the PolywrapClient
+config = builder.build()
+
+# build with a custom cache
+config = builder.build({
+  wrapperCache: WrapperCache(),
+})
+
+# or build with a custom resolver
+coreClientConfig = builder.build({
+  resolver: RecursiveResolver(...),
+})
+```