Skip to content

Commit c43ae8e

Browse files
authored
Update README.md
1 parent e83c508 commit c43ae8e

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,43 @@
1+
# REChain ® PerpStats
2+
3+
**REChain ® PerpStats** is a decentralized analytics engine for tracking REChain’s perpetual trading markets.
4+
5+
## 🔧 Setup
6+
7+
```bash
8+
git clone https://github.com/REChain-Network-Solutions/PerpStats.git
9+
cd PerpStats
10+
npm install
11+
npm run dev
12+
```
13+
14+
## 📈 What It Tracks
15+
16+
- Trading volume
17+
- Open interest
18+
- Liquidations
19+
- Funding rate history
20+
- Trader leaderboards
21+
- Smart contract events (on-chain)
22+
23+
## 🌐 REST API
24+
25+
All core metrics are exposed via `/api/perp/*` endpoints.
26+
27+
## 📊 UI
28+
29+
React/Vue frontend available under `/dashboard`.
30+
31+
## 🛡 Security
32+
33+
- Open source
34+
- Non-custodial
35+
- Privacy-preserving (future zk-stats module)
36+
37+
## 🧾 License
38+
39+
MIT License — REChain Network Solutions
40+
141
## Setup
242

343
Required:
@@ -13,4 +53,4 @@ Required:
1353
## start
1454
```shell
1555
npm start
16-
```
56+
```

0 commit comments

Comments
 (0)