From 88c064c7cd0a774d659629d867906d02604f9fea Mon Sep 17 00:00:00 2001
From: zaidarain1 <zaid.arain@immutable.com>
Date: Tue, 11 Jun 2024 15:50:29 +1000
Subject: [PATCH] Docs: [DX-2915] Add new README of "config" package (#1884)

---
 packages/config/README.md | 56 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 packages/config/README.md

diff --git a/packages/config/README.md b/packages/config/README.md
new file mode 100644
index 0000000000..0143abbd70
--- /dev/null
+++ b/packages/config/README.md
@@ -0,0 +1,56 @@
+# Config
+
+### Pre-requisites
+
+Install dependencies for the workspace
+
+```bash
+yarn install
+```
+
+### Quick Start Guide
+
+All commands below need to be run in the context of the `config` package where this README is located. Read more about context [here](../../../README.md#context).
+
+Running in `dev` mode:
+
+```bash
+yarn dev
+```
+
+Building to `./dist` directory with javascript output:
+
+```bash
+yarn build
+```
+
+Running all tests:
+
+```bash
+yarn test
+```
+
+Running changed tests in watch mode:
+
+```bash
+yarn test:watch
+```
+
+Linting:
+
+```bash
+yarn lint
+```
+
+Typechecking:
+
+```bash
+yarn typecheck
+```
+
+
+### About
+
+This package contains the configuration class that can be used to create a new configuration object that is then passed into the Typescript SDK when an external consumer initializes it. It also contains the configuration types, enums, utility functions that are used to assist with the setup of this configuration object.
+
+[Read more about the config package here](../../README.md#config)
\ No newline at end of file