Skip to content

Commit 4a06c6e

Browse files
authored
Merge pull request #5 from AnshMNSoni/AnshMNSoni-patch-2
Update README with new version and project details
2 parents 79fb400 + 9fa1fdc commit 4a06c6e

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@
33
[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
44
[![PyPI version](https://img.shields.io/pypi/v/pythonstl.svg)](https://pypi.org/project/pythonstl/)
55
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
6-
[![Version](https://img.shields.io/badge/version-0.1.0-brightgreen.svg)](https://github.com/AnshMNSoni/STL)
6+
[![Version](https://img.shields.io/badge/version-0.1.1-brightgreen.svg)](https://github.com/AnshMNSoni/PythonSTL)
77

8-
A production-ready Python package that replicates C++ STL-style data structures using the **Facade Design Pattern**. PythonSTL provides clean, familiar interfaces for developers coming from C++ while maintaining Pythonic best practices.
8+
<div align="center">
9+
<img width="500" height="500" alt="pythonstl_logo" src="https://github.com/user-attachments/assets/7ef83b5f-d005-48e0-a186-05dd7e2221c2" />
10+
</div><br>
11+
12+
A Python package that replicates C++ STL-style data structures using the **Facade Design Pattern**. PythonSTL provides clean, familiar interfaces for developers coming from C++ while maintaining Pythonic best practices.
913

1014
## Features
1115

@@ -28,8 +32,8 @@ pip install pythonstl
2832
Or install from source:
2933

3034
```bash
31-
git clone https://github.com/AnshMNSoni/STL.git
32-
cd STL
35+
git clone https://github.com/AnshMNSoni/PythonSTL.git
36+
cd PythonSTL
3337
pip install -e .
3438
```
3539

@@ -355,8 +359,8 @@ pytest tests/ --cov=pythonstl --cov-report=html
355359
### Setup
356360

357361
```bash
358-
git clone https://github.com/AnshMNSoni/STL.git
359-
cd STL
362+
git clone https://github.com/AnshMNSoni/PythonSTL.git
363+
cd PythonSTL
360364
pip install -e ".[dev]"
361365
```
362366

@@ -373,6 +377,10 @@ flake8 pythonstl/
373377
pytest && mypy pythonstl/ && flake8 pythonstl/
374378
```
375379

380+
## Note
381+
➡️ The goal is NOT to replace Python built-ins.<br>
382+
➡️ The goal is to provide: 1) Conceptual clarity 2) STL familiarity for C++ developers 3) A structured learning bridge for DSA <br>
383+
376384
## 📝 License
377385

378386
MIT License - see LICENSE file for details.
@@ -386,9 +394,10 @@ Contributions are welcome! Please:
386394
4. Ensure all tests pass
387395
5. Submit a pull request
388396

397+
## Thankyou
389398
## Contact
390399

391400
- GitHub: [@AnshMNSoni](https://github.com/AnshMNSoni)
392-
- Issues: [GitHub Issues](https://github.com/AnshMNSoni/STL/issues)
401+
- Issues: [GitHub Issues](https://github.com/AnshMNSoni/PythonSTL/issues)
393402

394403
**PythonSTL v0.1.0** - Bringing C++ STL elegance to Python

0 commit comments

Comments
 (0)