Skip to content
This repository has been archived by the owner on Nov 20, 2024. It is now read-only.

Commit

Permalink
docs: add project description in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
davidsantana06 committed Dec 24, 2023
1 parent 4e8c721 commit 2c872b9
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# LinkeDS

This project introduces a versatile implementation of linked data structures, encompassing stacks, queues, and linked lists. The structures are designed for
adaptability, available in both bounded and dynamic size variations. Single and doubly linked nodes facilitate flexible element connections.

Incorporating advanced features, the project includes a Jsonifier class, which acts as an Abstract Base Class (ABC) for JSON serialization and deserialization.
This comprehensive toolkit empowers developers with efficient and flexible linked data structures, suitable for diverse programming needs.

> [!NOTE]
> This project has been developed based on Python 3.6 or above.
<br />



## :rocket: Features

1. **Bounded and Dynamic Sizes**: Choose between bounded and dynamic sizes for each structure, offering flexibility in managing element capacity.
2. **Single and Doubly Linked Nodes**: Utilize both single and doubly linked nodes to facilitate versatile connections between elements.
3. **Efficient Stack Operations**: Execute all standard operations for each data structure, including bounded and dynamic sizes.
4. **Serialization of List**: Serialize the entire list effortlessly to JSON format, enabling easy persistence and interchangeability.

<br />



## :balance_scale: License

This project adopts the **MIT License**, which allows you to use and make modifications to the code as you wish. The only thing I ask is that proper credit is given, acknowledging the effort and time I invested in building it.

0 comments on commit 2c872b9

Please sign in to comment.