diff --git a/README.md b/README.md index 7183a9b..8e3b97d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,53 @@ # Data-Structures-CPP -[WIP] My rendition of every commonly used data-structure (that is not supported) in C++. +
+ +![WIP_STATUS](https://img.shields.io/badge/STATUS-WIP-RED?style=for-the-badge&color=red) +![REPO_STARS](https://img.shields.io/github/stars/SleepiCaffeine/Data-Structures-CPP?style=for-the-badge&label=stars&color=ffc336) +![FORK_STATS](https://img.shields.io/github/forks/SleepiCaffeine/Data-Structures-CPP?style=for-the-badge&color=white) + +
+ +
+ +![FOLLOW .-.](https://img.shields.io/github/followers/SleepiCaffeine?style=social&labelColor=purple&color=purple) + +
+ + +A header-only, STL-like library for node-type data structures that are not natively supported by **STL**. All headers are documented using Doxygen comments.
+Currently - all supported data structures and class are [here](https://github.com/SleepiCaffeine/Data-Structures-CPP/blob/main/Data%20Structures/currentVersion.md). + +## How to use +Simply include `data_structues.hpp` or any individual header, and start using it. If you are unsure how to clone a repository - [read here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). + +## Example of use +All classes and types will have their own users-guide, and hopefully a Doxygen generated documentation PDF. +``` +#include "node.h" +#include + +int main() { + Node* myNode = new Node(10); // Creates a node with value 10, and points to nothing + auto myOtherNode = new Node(20); // Creates a node with value 20, and points to nothing + + myNode.set_next(myOtherNode); // Now `myNode` points to `myOtherNode` + std::cout << myNode->get_next()->get_data() << "\n"; // Output is 20 + + auto copyNode = Node(*myNode); + myNode->set_data(35); + + std::cout << myNode->->get_data() << "\n"; // Output is 35 + std::cout << copyNode->get_data() << "\n"; // Output is 10 + + return 0; +} +``` + +## Issues and Pull Requests +Currently there is no template for providing issues, so anything is appreciated! + +## Authors +I am the only developer working on this + +## License +This project is protected by the MIT license.