From 010b0aa0a865336fb6fb5da92c3aa676c7bbe53d Mon Sep 17 00:00:00 2001
From: abtestingalpha <abtestingalpha@gmail.com>
Date: Thu, 10 Oct 2024 13:44:18 -0400
Subject: [PATCH] Updates readme

---
 packages/synapse-constants/README.md | 46 ++++++++++------------------
 1 file changed, 17 insertions(+), 29 deletions(-)

diff --git a/packages/synapse-constants/README.md b/packages/synapse-constants/README.md
index 94f44f48c7..f0e21d4947 100644
--- a/packages/synapse-constants/README.md
+++ b/packages/synapse-constants/README.md
@@ -1,53 +1,41 @@
 # Synapse Constants
+
 [![npm](https://img.shields.io/npm/v/synapse-constants?style=flat-square)](https://www.npmjs.com/package/synapse-constants)
 
 This package contains the Synapse Protocol Token and Chain Constants
 
-
-#
-
-
-
 ## Installation
 
-```bash
-npm install synapse-constants
-```
-
 With Yarn:
 
 ```bash
-yarn add synapse-constants
+yarn add @synapsecns/synapse-constants
 ```
 
-## Usage
-
-
-To restrict the assets and chains that are imported, you can create a "custom bridge list". From the set of all tokens imported from "bridgeable.ts" you can import specific tokens and use that as the custom list you use in your application. The same can be done for chains
+## Build
 
-## Usage
-For maintenance, when new tokens are added to the bridge the following steps should be taken.
+The following command will build the package locally
 
-1. Regenerate bridgeMaps.ts
-
-```bash
-yarn maps:generate
+```
+yarn build
 ```
 
-2. Update Bridgeable.ts with the new token addresses (check all other variables like decimals/ symbols etc. )
+## Usage
 
-3. Repackage and webpack all of the data
+Importing supported tokens and chains:
 
-```bash
-yarn compile
+```js
+import { BRIDGABLE_TOKENS, CHAINS } from '@synapsecns/synapse-constants'
 ```
 
-4. Republish the npm package (make sure to update the version)
+Importing a specific token:
 
-```bash
-npm publish
+```js
+import { USDC } from '@synapsecns/synapse-constants'
 ```
 
+## TODO
 
-TODO:
-- add the basic structure of the token type and the chain type to show accessibility for token logos, chain logos, and any additional information.
+- [ ] Instructions on adding new chains
+- [ ] Instructions on adding new tokens
+- [ ] Instructions on generating new token route map