Skip to content

Commit a6f7d3c

Browse files
author
Alex K
committed
docs(readme): update README with GitHub-safe markdown and badges
1 parent 0ca3c3a commit a6f7d3c

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
1-
# AlphaQuant
21

32
```markdown
4-
<h1 align="center">
5-
⚡️ AlphaQuant
6-
</h1>
3+
# ⚡️ AlphaQuant
74

8-
<p align="center">
9-
<b>Modern JavaScript Framework for Quantitative Finance</b><br>
10-
<i>Pandas + TA-Lib + Backtrader — all in JS</i>
11-
</p>
5+
**Modern JavaScript Framework for Quantitative Finance**
6+
_Pandas + TA-Lib + Backtrader — all in JS_
127

138
<p align="center">
149
<a href="https://github.com/alphaquant/alphaquant/actions/workflows/ci.yml">
@@ -22,9 +17,7 @@
2217
<img src="https://img.shields.io/badge/status-MVP-orange?style=flat-square" />
2318
</p>
2419

25-
<p align="center">
26-
<img src="https://user-images.githubusercontent.com/674621/196881240-fbccdcf4-753e-4f82-a8b5-e471d6c13d02.gif" width="600" alt="demo gif" />
27-
</p>
20+
![AlphaQuant Demo](https://user-images.githubusercontent.com/674621/196881240-fbccdcf4-753e-4f82-a8b5-e471d6c13d02.gif)
2821

2922
---
3023

@@ -59,7 +52,7 @@ Full example: [`examples/sma-cross.ts`](./examples/sma-cross.ts)
5952

6053
---
6154

62-
## 🧠 Architecture
55+
## 📁 Monorepo Structure
6356

6457
```
6558
/packages/
@@ -85,7 +78,7 @@ turbo run test # Run tests (WIP)
8578
npx changeset # Start new release
8679
```
8780

88-
🔁 CI/CD is fully automated via GitHub Actions + Changesets. See [How CI/CD Works](#️how-cicd-works)
81+
CI/CD is fully automated via GitHub Actions + Changesets. See [How CI/CD Works](#️how-cicd-works)
8982

9083
---
9184

@@ -145,4 +138,3 @@ Together we can bring **quant tools to the web**.
145138

146139
MIT © AlphaQuant Authors — use freely, build boldly.
147140
```
148-

0 commit comments

Comments
 (0)