Merge pull request #20 from oliviacarlisle/dev

Update README

Author: oliviacarlisle

README.md

@@ -4,30 +4,44 @@
 [![Build Status](https://github.com/oliviacarlisle/core-dslib/actions/workflows/ci.yml/badge.svg)](https://github.com/oliviacarlisle/core-dslib/actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**A simple yet powerful data structures library for TypeScript and JavaScript projects.**
+A robust and efficient data structures library.
 
-Designed for production environments and scalability, **core-dslib** is a developer's versatile toolbox for projects of any size. It provides essential data structures that enhance the capabilities of TypeScript and JavaScript, filling in the gaps left by the standard libraries.
+## ✨ Features
 
-> **Note:** Currently only compatible with ESM projects.
+- 🧰 **Foundational**: Growing collection of essential data structures
+- 🛡️ **Reliable**: Robust stability with 100% test coverage
+- ⚡ **High-Performance**: Optimized for efficiency in demanding applications
+- ⛰️ **Scalable**: Adaptable for projects of any size
+- 🪶 **Lightweight**: Zero dependencies, keeping your project lean
+- 🔷 **TypeScript Native**: Full type safety and intelligent code completion
 
 ## Table of Contents
 
-- [Installation](#installation)
-- [Getting Started](#getting-started)
-- [Data Structures](#data-structures)
-  - [Queue](#queue)
-- [Contributing](#contributing)
-- [License](#license)
+- [💡 Why core-dslib?](#-why-core-dslib)
+- [📦 Installation](#-installation)
+- [🚀 Getting Started](#-getting-started)
+- [🏗️ Data Structures](#%EF%B8%8F-data-structures)
+  - [🔄 Queue](#-queue)
+- [🌟 Contributing](#-contributing)
+- [⚖️ License](#%EF%B8%8F-license)
+
+## 💡 Why core-dslib?
+
+`core-dslib` is your go-to toolkit for advanced data structures in TypeScript and JavaScript. It bridges the gap left by standard libraries, empowering developers with the tools they need for efficient data management and manipulation.
+
+Whether you're building a complex algorithm or optimizing application performance, `core-dslib` provides the building blocks you need to succeed.
+
+> **Note:** Currently only compatible with ESM projects.
 
-## Installation
+## 📦 Installation
 
 Install the package via npm:
 
 ```bash
 npm install core-dslib
 ```
 
-## Getting Started
+## 🚀 Getting Started
 
 Import using ESM syntax:
 
@@ -43,9 +57,9 @@ queue.enqueue(3);
 console.log(queue.dequeue()); // Output: 3
 ```
 
-## Data Structures
+## 🏗️ Data Structures
 
-### Queue
+### 🔄 Queue
 
 Implemented using a circular buffer to ensure efficient enqueue and dequeue operations.
 
@@ -54,6 +68,7 @@ Implemented using a circular buffer to ensure efficient enqueue and dequeue oper
 - **Performance:** Enqueue and dequeue operations with amortized O(1) complexity.
 - **Dynamic Resizing:** Automatically resizes to manage memory usage efficiently.
 - **Iterable**: Implements the `Iterable` interface, allowing you to use the queue with `for...of` loops, spread (`...`) syntax and other iterable contexts.
+- **Enhanced Runtime Privacy**: Leverages ES2022 private class fields (`#`) for robust encapsulation, ensuring data privacy during execution.
 - **Type Safety:** Fully typed for TypeScript, ensuring type safety and IntelliSense support.
 - **Versatility:** Suitable for handling numbers, strings, objects, and more.
 
@@ -201,7 +216,7 @@ tsx v4.19.1
 node v20.17.0
 ```
 
-## Contributing
+## 🌟 Contributing
 
 Contributions are welcome! If you have ideas, suggestions, or find any issues, please open an [issue](https://github.com/oliviacarlisle/core-dslib/issues) or submit a [pull request](https://github.com/oliviacarlisle/core-dslib/pulls).
 
@@ -226,7 +241,7 @@ Run tests:
 npm test
 ```
 
-## License
+## ⚖️ License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "core-dslib",
   "version": "1.0.0",
-  "description": "A simple yet powerful data structures library for TypeScript and JavaScript projects.",
+  "description": "A robust and efficient data structures library.",
   "type": "module",
   "scripts": {
     "test": "jest",
@@ -21,6 +21,9 @@
     "enqueue",
     "dequeue"
   ],
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "author": "Olivia Carlisle",
   "license": "MIT",
   "exports": {