From 4c674d5922c342c426ce1668382919d120f67bab Mon Sep 17 00:00:00 2001
From: Sreecharan <65058816+sr2echa@users.noreply.github.com>
Date: Fri, 1 Dec 2023 17:29:33 +0530
Subject: [PATCH] Update README.md
---
README.md | 104 ++++++++++++------------------------------------------
1 file changed, 22 insertions(+), 82 deletions(-)
diff --git a/README.md b/README.md
index 7517c0c..4c06f9a 100644
--- a/README.md
+++ b/README.md
@@ -1,94 +1,34 @@
---
+> [!NOTE]
+> **Made for RevaHack 23 ❤️**
+> We even won the **1st place** and were the **Title Winners of RevaHack 23**! More about it here 👉 Devfolio
-Here's the properly formatted content:
-
-## Frontend
-### STREAMLIT: [https://dirtymoneydetector.streamlit.app](https://dirtymoneydetector.streamlit.app)
-🔗 [Source Code](./web)
---
-### API LINK: [https://dirtyapi.replit.app/](https://dirtyapi.replit.app)
-## API Reference
-### Path: `/api/`
-### Output:
-```json
-{
- "Address": "string",
- "Avg min between received tnx": "float",
- "Avg min between sent tnx": "float",
- "AvgValSent": "float",
- "AvgValueReceived5Average": "float",
- "AvgValueSentToContract": "int",
- "ERC20AvgTimeBetweenRec_Tnx": "float",
- "ERC20AvgTimeBetweenSent_Tnx": "float",
- "ERC20AvgVal_Rec": "float",
- "ERC20AvgVal_Sent": "float",
- "ERC20MaxVal_Rec": "float",
- "ERC20MaxVal_Sent": "float",
- "ERC20MinVal_Rec": "float",
- "ERC20MinVal_Sent": "float",
- "ERC20MostRecTokenType": "string",
- "ERC20MostSentTokenType": "string",
- "ERC20TotalEtherSentContract": "float",
- "ERC20TotalEther_Received": "float",
- "ERC20TotalEther_Sent": "float",
- "ERC20UniqRecContractAddr": "int",
- "ERC20UniqRecTokenName": "int",
- "ERC20UniqRec_Addr": "int",
- "ERC20UniqSentTokenName": "int",
- "ERC20UniqSent_Addr": "int",
- "MaxValSent": "float",
- "MaxValueReceived": "float",
- "MaxValueSentToContract": "float",
- "MinValSent": "float",
- "MinValueReceived": "float",
- "MinValueSentToContract": "float",
- "NumberofCreated_Contracts": "int",
- "Received_tnx": "int",
- "Sent_tnx": "int",
- "Time Diff between first and_last (Mins)": "float",
- "TotalERC20Tnxs": "int",
- "TotalEtherBalance": "float",
- "TotalEtherReceived": "float",
- "TotalEtherSent": "float",
- "TotalEtherSent_Contracts": "float",
- "TotalTransactions": "int",
- "UniqueReceivedFrom_Addresses": "int",
- "UniqueSentTo_Addresses20": "int"
-}
-```
----
-## ML Model
-[sourcecode](./ML)
-## How to Use
+## The Problem It Solves
+In the world of digital finance, the rise of cryptocurrencies has been meteoric. While they offer unprecedented opportunities for investment and transaction, they have also opened up new avenues for financial misconduct, such as fraud and money laundering. Traditional methods of tracking and scrutinizing financial transactions are often ill-suited to the decentralized and anonymous nature of blockchain-based currencies. This is where "DMD" steps in as a game-changer.
+Our web app, "DMD," is designed to tackle this very challenge by providing a robust analysis of wallet transactions within the blockchain ecosystem. Here’s how "DMD" stands out and solves pressing problems:
+
+### `Fraud Detection`
+By monitoring transaction patterns, "DMD" can identify anomalies that may indicate fraudulent activity. This preemptive detection helps users and financial institutions mitigate risks before they balloon into significant threats.
-1. Clone the Repository
-```bash
- git clone https://github.com/sr2echa/dirty-moni-detector.git
-```
+### `Anti-Money Laundering (AML)`
+"DMD" applies advanced algorithms to scrutinize the rate and nature of transactions, as well as smart contract interactions, to flag potential money laundering activities, ensuring compliance with AML regulations.
-2. Install all requirments and dependencies
-```bash
-pip install -r requirments.txt
-```
-3. Run the application:
-```bash
-streamlit run website.py
-```
+### `User Empowerment`
+By providing detailed analyses and reports, "DMD" empowers users with knowledge about their transaction habits and network health, enabling informed decision-making.
-## Tech Stack
-
-
-
+### `Boosting Confidence`
+"DMD" instills confidence in cryptocurrency users, enabling them to engage in digital transactions without fear of hidden dangers. It fosters a safer environment for all participants in the crypto market.
-- [x] Streamlit
-- [x] Tensorflow
-- [x] Github
-- [x] replit
-- [x] Flask
-- [x] Seaborn
+
+
+In summary, "DMD" is not just a tool—it's an essential ally in maintaining the integrity of financial transactions within the digital space. It transforms the complex and often opaque landscape of blockchain transactions into a more secure and transparent domain, ensuring that the digital economy remains a level playing field for all participants.
+
+---
-
+> [!IMPORTANT]
+> Documentation of the codebase has been shifted to [docs.md](./docs.md)
-