Skip to content

Commit 36bcaad

Browse files
committed
Make the readme more user friendly
1 parent 6d4ac27 commit 36bcaad

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A pure‑Python SQLAlchemy 2.0 dialect that runs entirely in RAM.
1212
It avoids typical database I/O and ORM overhead while maintaining full compatibility with the SQLAlchemy 2.0 Core and ORM APIs.
1313
Ideal for rapid prototyping, backtesting engines, simulations.
1414

15-
## Why ?
15+
## Why ?
1616

1717
This project was inspired by the idea of building a **fast, introspectable, no-dependency backend** for SQLAlchemy.
1818

@@ -30,7 +30,7 @@ It is also perfect for **applications that need a lightweight, high-performance
3030

3131
Data is kept purely in RAM and is **volatile**: it is **not persisted across application restarts** and is **cleared when the engine is disposed**.
3232

33-
## Features
33+
## Features
3434

3535
- **SQLAlchemy 2.0 support**: ORM & Core expressions, sync & async modes
3636
- **Zero I/O overhead**: pure in‑RAM storage (`dict`/`list` under the hood)
@@ -40,27 +40,27 @@ Data is kept purely in RAM and is **volatile**: it is **not persisted across app
4040
- `first()`-style queries avoid scanning the full dataset
4141
- Optimized for read-heavy workloads and streaming filters
4242

43-
## Benchmark
43+
## 📊 Benchmark
4444

4545
Curious how `sqlalchemy-memory` stacks up?
4646

4747
[View Benchmark Results](https://sqlalchemy-memory.readthedocs.io/en/latest/benchmarks.html) comparing `sqlalchemy-memory` to `in-memory SQLite`
4848

49-
## Installation
49+
## 📦 Installation
5050

5151
```bash
5252
pip install sqlalchemy-memory
5353
```
5454

55-
## Documentation
55+
## 📘 Documentation
5656

57-
[See the official documentation for usage examples](https://sqlalchemy-memory.readthedocs.io/en/latest/)
57+
👉 [See the official documentation for usage examples](https://sqlalchemy-memory.readthedocs.io/en/latest/)
5858

59-
## Testing
59+
## 🧪 Testing
6060

6161
Simply run `make tests`
6262

63-
## License
63+
## 📄 License
6464

6565
This project is licensed under the MIT License.
6666
See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)