From ff5807a915bb9c6ad8f31a4ba4a59d9670073b45 Mon Sep 17 00:00:00 2001
From: Mathias Scherer <mathias@aragon.org>
Date: Wed, 24 Jan 2024 15:25:31 +0100
Subject: [PATCH 1/2] docs(configs): adds readme for configs package

---
 configs/README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 sdk/README.md     |  6 +++---
 2 files changed, 48 insertions(+), 3 deletions(-)
 create mode 100644 configs/README.md

diff --git a/configs/README.md b/configs/README.md
new file mode 100644
index 00000000..3ddec1eb
--- /dev/null
+++ b/configs/README.md
@@ -0,0 +1,45 @@
+# Aragon OSx Configs Commons
+
+The `@aragon/osx-commons-configs` provides configurations and helpers for said
+configurations necessary for the development of plugins and the OSx protocol.
+This includes:
+
+- Networks
+  - RPC url
+  - if it is a testnet or not
+  - chainID
+  - alias for ethers and Alchemy subgraph
+- Deployments of the OSx protocol grouped by network
+  - Version
+  - Contract name
+  - Contract address
+  - Deployment transaction
+  - Block number when the contract was deployed (This can differ from when the
+    contract was activated and put in use)
+
+## Installation
+
+Use [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install
+@aragon/osx-commons-configs.
+
+```bash
+npm install @aragon/osx-commons-configs
+yarn add @aragon/osx-commons-configs
+```
+
+## Testing
+
+To execute library tests just run:
+
+```bash
+yarn test
+```
+
+## Security
+
+If you believe you've found a security issue, we encourage you to notify us. We
+welcome working with you to resolve the issue promptly.
+
+Security Contact Email: sirt@aragon.org
+
+Please do not use the issue tracker for security issues.
diff --git a/sdk/README.md b/sdk/README.md
index b5f1a97e..605b9bfa 100644
--- a/sdk/README.md
+++ b/sdk/README.md
@@ -14,7 +14,7 @@
 - Extendable JS client with built-in Web3, Subgraph and IPFS
 - Extendable context for holding inheritable configuration
 
-# Installation
+## Installation
 
 Use [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install
 @aragon/osx-commons-sdk.
@@ -24,7 +24,7 @@ npm install @aragon/osx-commons-sdk
 yarn add @aragon/osx-commons-sdk
 ```
 
-# Usage
+## Usage
 
 The SDK usage is demonstrated in the
 [SDK examples section of the Developer Portal](https://devs.aragon.org/docs/sdk/examples/).
@@ -64,7 +64,7 @@ When updating the `ClientCore` class:
 - **Update first** all affected enum's, types and interfaces in
   `src/internal/interfaces.ts`
 
-# Testing
+## Testing
 
 To execute library tests just run:
 

From ade2e9aff07781e126f29e162a5f15e9b2440832 Mon Sep 17 00:00:00 2001
From: Mathias Scherer <mathias@aragon.org>
Date: Wed, 31 Jan 2024 11:05:22 +0100
Subject: [PATCH 2/2] docs(config): updates readme with small changes

---
 configs/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/configs/README.md b/configs/README.md
index 3ddec1eb..596229c6 100644
--- a/configs/README.md
+++ b/configs/README.md
@@ -7,14 +7,14 @@ This includes:
 - Networks
   - RPC url
   - if it is a testnet or not
-  - chainID
+  - chain ID
   - alias for ethers and Alchemy subgraph
 - Deployments of the OSx protocol grouped by network
   - Version
   - Contract name
   - Contract address
   - Deployment transaction
-  - Block number when the contract was deployed (This can differ from when the
+  - Block number when the contract was deployed (which can differ from when the
     contract was activated and put in use)
 
 ## Installation