diff --git a/README.md b/README.md index 036d338..22cc7a5 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,13 @@ [![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/) [![PyPI version](https://img.shields.io/pypi/v/pythonstl.svg)](https://pypi.org/project/pythonstl/) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) -[![Version](https://img.shields.io/badge/version-0.1.0-brightgreen.svg)](https://github.com/AnshMNSoni/STL) +[![Version](https://img.shields.io/badge/version-0.1.1-brightgreen.svg)](https://github.com/AnshMNSoni/PythonSTL) -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. +
+ pythonstl_logo +

+ +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. ## Features @@ -28,8 +32,8 @@ pip install pythonstl Or install from source: ```bash -git clone https://github.com/AnshMNSoni/STL.git -cd STL +git clone https://github.com/AnshMNSoni/PythonSTL.git +cd PythonSTL pip install -e . ``` @@ -355,8 +359,8 @@ pytest tests/ --cov=pythonstl --cov-report=html ### Setup ```bash -git clone https://github.com/AnshMNSoni/STL.git -cd STL +git clone https://github.com/AnshMNSoni/PythonSTL.git +cd PythonSTL pip install -e ".[dev]" ``` @@ -373,6 +377,10 @@ flake8 pythonstl/ pytest && mypy pythonstl/ && flake8 pythonstl/ ``` +## Note +➡️ The goal is NOT to replace Python built-ins.
+➡️ The goal is to provide: 1) Conceptual clarity 2) STL familiarity for C++ developers 3) A structured learning bridge for DSA
+ ## 📝 License MIT License - see LICENSE file for details. @@ -386,9 +394,10 @@ Contributions are welcome! Please: 4. Ensure all tests pass 5. Submit a pull request +## Thankyou ## Contact - GitHub: [@AnshMNSoni](https://github.com/AnshMNSoni) -- Issues: [GitHub Issues](https://github.com/AnshMNSoni/STL/issues) +- Issues: [GitHub Issues](https://github.com/AnshMNSoni/PythonSTL/issues) **PythonSTL v0.1.0** - Bringing C++ STL elegance to Python