docs - create a project roadmap

[bengarishodge]

Description

Should create a simple roadmap to define what the milestones are. Roadmap should be visible and tracked.

Todo

• define roadmap by looking at what i've had to implement in kobolds to get it working.
• make document

[bengarishodge]

What is the goal

I want this project to include some basics in functionality that I wish was in the standard library. The standard library already has a ton of really useful tools when working with arrays and hashmaps but i feel is missing a few things that make writing production code a little bit easier. Coming from higher level languages like js/ts, go, elixir, ruby and others, there are a lot of nice tools that come out of the box BUT the problem with every one of the languages listed are that the dependency trees explode when you try to add anything. Even the simplest of dependencies are full of trash. zig does tree-shaking out of the box so you only pay for what you use which isn't necessarily true of any of the other languages listed.

The goal of this project is to be fairly comprehensive and have no dependencies except for the zig standard library.

How do I use this library?

I use this library as a dependency for kobolds a distributed message broker written in zig. Everything inside of this library has been used inside of kobolds to solve a specific problem. Because kobolds aims to be pretty quick, the tools in this library need to be pretty quick. That is why I am putting such an emphasis on benchmarking and unit testing for each ds/alg.

How should others use this library?

I don't care how you implement this in your projects. If you think it is useful or want to make improvements just let me know and we can talk about it.