From 24132cbd6499a3158f7b84475ffa66db89436339 Mon Sep 17 00:00:00 2001
From: Geolffrey Mena <gmjun2000@gmail.com>
Date: Fri, 27 Dec 2024 11:42:15 -0600
Subject: [PATCH] updated readme

---
 README.md | 90 +++++++++++++++++++++++--------------------------------
 1 file changed, 37 insertions(+), 53 deletions(-)

diff --git a/README.md b/README.md
index 9265b45..f299016 100644
--- a/README.md
+++ b/README.md
@@ -1,66 +1,50 @@
-## Foundry
 
-**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+[![CI](https://github.com/Synaps3Protocol/protocol-core-v1/actions/workflows/ci.yaml/badge.svg)](https://github.com/Synaps3Protocol/protocol-core-v1/actions/workflows/ci.yaml)
+[![COV](https://raw.githubusercontent.com/Synaps3Protocol/protocol-core-v1/main/.github/workflows/cov-badge.svg)](https://github.com/Synaps3Protocol/protocol-core-v1/actions/workflows/ci.yaml)
 
-Foundry consists of:
+# Synapse Protocol
+Welcome! 🎉 Synapse is redefining how creative IP distribution works. Whether it's films, music, or games, we ensure creators stay in control of their work while earning fairly. With the power of blockchain, Synapse eliminates middlemen and automates licensing, payments, and content delivery through smart contracts. This lets creators focus on their craft, knowing their content is distributed safely and transparently.
 
--   **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
--   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
--   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
--   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+![image](https://github.com/user-attachments/assets/59610c00-672d-4eec-88dc-71b4fc8add59)
 
-## Documentation
+## Smart Contracts:
 
-https://book.getfoundry.sh/
+* CREATE3_FACTORY=0x73976B6fF10C05bA01DD8B15Acb1Fa2438A516d3
+* ACCESS_MANAGER=0x0eA49DF2376393719F67e039923ef75E1767e9Ee
+* MMC=0xdC2E7C4444730980CEB8982CfC8A1c4902fa36bE
+* TOLLGATE=0xc29A74692C9B2e60FA088164d5F3EE933C3B2236
+* TREASURY=0xe20bA93d9DB6590746013cfe5f6a32312a0b0280
+* ASSET_REFERENDUM=0xE3dFE3B891B850B8682a1f249e8010A7cC1fC79b
+* ASSET_OWNERSHIP=0x73547510a29034650B5975c4546710a78A7ADCCC
+* ASSET_VAULT=0x95d52337E6f4A46DcB0eb8DebCDE0CC5ae73D10b
+* DISTRIBUTION_REFERENDUM=0xC44654946a32a42Cd7fD6AFA02DD0F5857865830
+* DISTRIBUTION_FACTORY=0xF0F23c3d5F27c73e624b1556a6CF5820FF4f11a4
+* POLICY_AUDIT=0x80Ba937A405A1fA5e9f22906DeC7fF2F091b2C7C
+* RIGHT_ASSET_CUSTODIAN=0x1570fFF8D0eDEBC2629e8A9Ac11CB57DC4D2e7a1
+* RIGHT_ACCESS_AGREEMENT=0x5D73460ff68975C4E31000d32ec23497a7AA4D12
+* RIGHT_POLICY_AUTHORIZER=0x8D36e7aF7ed59774A882bB97623979fDCBDf6538
+* RIGHT_POLICY_MANAGER=0xc16786368DCDE7F225b4980B2E01dF0eDcD2D337
 
-## Usage
+## Join the Fun
+Found a bug? Got a cool idea? Open a pull request or start a discussion on GitHub. We’d love to build this together!
 
-### Build
+## Development
 
-```shell
-$ forge build
-```
+Some available capabilities for dev support:
 
-### Test
+* **Run Tests**: `make test`  
+* **Compile Contracts**: `make compile`  
+* **Force Compile Contracts**: `make force-compile`  
+* **Test Coverage Report**: `make coverage`  
+* **Generate Security Report**: `make secreport`  
+* **Run Security Tests**: `make sectest`  
+* **Format Code**: `make format`  
+* **Lint Code**: `make lint`   
 
-```shell
-$ forge test
-```
+Note: Run `make help` to see additional capabilities.
 
-### Format
+## References
 
-```shell
-$ forge fmt
-```
+- Code Maturity: https://github.com/crytic/building-secure-contracts/blob/master/development-guidelines/code_maturity.md
 
-### Gas Snapshots
-
-```shell
-$ forge snapshot
-```
-
-### Anvil
-
-```shell
-$ anvil
-```
-
-### Deploy
-
-```shell
-$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
-```
-
-### Cast
-
-```shell
-$ cast <subcommand>
-```
-
-### Help
-
-```shell
-$ forge --help
-$ anvil --help
-$ cast --help
-```
+- Style Guide: https://docs.soliditylang.org/en/latest/style-guide.html
\ No newline at end of file