Skip to content

Commit d34a314

Browse files
docs: update README with PyPI installation instructions and badge
1 parent 49b695e commit d34a314

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# QuantLab - Quantitative Trading Research Platform
22

3+
[![PyPI version](https://img.shields.io/pypi/v/quantlabs.svg)](https://pypi.org/project/quantlabs/)
34
[![Documentation Status](https://readthedocs.org/projects/quantlabs/badge/?version=latest)](https://quantlabs.readthedocs.io/en/latest/?badge=latest)
45
[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
56
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
@@ -63,18 +64,36 @@ quantlab/
6364

6465
## 🚀 Quick Start
6566

66-
### 1. Setup Environment
67+
### Installation from PyPI
6768

6869
```bash
70+
# Install from PyPI
71+
pip install quantlabs
72+
73+
# Or using uv (recommended)
74+
uv pip install quantlabs
75+
76+
# Verify installation
77+
quantlab --version
78+
quantlab --help
79+
```
80+
81+
### Development Setup
82+
83+
```bash
84+
# Clone the repository
85+
git clone https://github.com/nittygritty-zzy/quantlab.git
86+
cd quantlab
87+
6988
# Using uv (recommended)
7089
uv venv
7190
source .venv/bin/activate
72-
uv pip install qlib
91+
uv sync
7392

7493
# Or using pip
7594
python -m venv .venv
7695
source .venv/bin/activate
77-
pip install qlib
96+
pip install -e .
7897
```
7998

8099
### 2. Prepare Data

0 commit comments

Comments
 (0)