Dev changes (#5)

* Fixed dependency * Updates to NeoDictionary * Changes to NeoDictionary * Started working on a Git implementation to integrate into Game Engines in the future * Added commit functionality to the git library * New changes * Added select for NeoDictionary.cs * Fixed issue with previous new method * Added a Benchmarking Tool to be used mostly in game engines * Added IndexOf to NeoDictionary.cs * Added new method for BenchmarkUtility.cs * added an instacedobject class * Added a new shuffle method for lists * fixed return type * Added new Changelog generator * Added new Game logic library to assist with game projects * Added Web Project * Added Nuget package configs * Add workflow for publishing game library NuGet package * Add README for OmegaLeo's Helper Library * Updated Website to reflect all libraries * Fixed missing library in Changelog * Added Contributing and Code of Conduct * Fixed web project * new documentation changes * fix packages * Fixed DocumentationHelper package dependencies * Added Serilog * Added logging * Fixed documentation * Added logging for cache * fixed documentation * Updated README.md * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update OmegaLeo.HelperLib.Web/Controllers/HomeController.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update OmegaLeo.HelperLib.Web/Controllers/HomeController.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix error --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-12-23 16:37:30 +00:00
parent b8a3a78e1d
commit 53650e4bfe
21 changed files with 458 additions and 51 deletions
@@ -1,6 +1,50 @@
 # HelperLib
-Library to help with C# projects and with game development using C#

+Lightweight utility library for C\# projects and game development helpers.
+
+## Table of contents
+
+- [Overview](#overview)
+- [Features](#features)
+- [Install](#install)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+- [Socials](#socials)
+
+## Overview
+
+`HelperLib` contains small helpers and abstractions commonly useful in application and game development (helpers for collections, math, and utilities to keep game and engine code concise).
+
+## Features
+
+- Small, focused utilities for C\#
+- Helpers that favor clarity and testability
+- Game development specific helpers in the `OmegaLeo.HelperLib.Game` package
+- Changelog generation utilities in the `OmegaLeo.HelperLib.Changelog` package
+- Lightweight and easy to integrate into existing projects
+- Well-documented and maintained
+- Open source under the AGPL v3 License
+
+## Install
+
+Add the library to your project via NuGet:
+
+```bash
+dotnet add package OmegaLeo.HelperLib
+dotnet add package OmegaLeo.HelperLib.Game
+dotnet add package OmegaLeo.HelperLib.Changelog
+```
+  
+## Documentation
+The documentation for this project can be found at [https://library.omegaleo.dev](https://library.omegaleo.dev).
+This documentation is automatically generated from the code using the [NetFlow.DocumentationHelper.Library](https://github.com/omegaleo/Netflow.DocumentationHelper).
+
+## Contributing
+Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines.
+
+## License
+This project is licensed under the AGPL v3 License. See the [LICENSE](LICENSE) file for details.

 ## Socials
 [![Youtube](https://img.shields.io/youtube/channel/subscribers/UCsdYKC7EK4Z_cpgWt0YiO9Q?style=plastic&label=Youtube&color=red