From 275befc258484ec20df241d0afd42c82510ebd3e Mon Sep 17 00:00:00 2001 From: Khwezi Mngoma Date: Sun, 10 May 2026 09:48:12 +0200 Subject: [PATCH] Populated README --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f355470..aa43ab3 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# LiteCharmsShared \ No newline at end of file +# LiteCharms.Components + +A suite of shared libraries providing core logic, models, and infrastructure for the LiteCharms ecosystem. + +## 📦 Published Packages +All packages are versioned and pushed to [Nexus](https://nexus.khongisa.co.za) automatically via CI/CD. + +* **Abstractions:** Interfaces and base contracts. +* **Models:** Shared DTOs and Request/Response objects. +* **Entities:** Database schema definitions. +* **Infrastructure:** Persistence and external service clients. +* **Features:** Core business logic modules. +* **Extensions:** Shared helper methods and DI configurations. + +## 🚀 CI/CD Workflow +1. Create a **Pull Request** to `master`. +2. Drone CI builds, tests, and packs the suite as `1.${DRONE_BUILD_NUMBER}.0`. +3. Packages are pushed to the Nexus `nuget-hosted` repository. +4. A formal **Gitea Release** is created with the versioned "Bill of Materials." + +## 🛠 Usage +Add the Nexus NuGet source to your local environment and reference the version listed in the latest Gitea Release: +`dotnet add package LiteCharms.Models -v 1.XX.0` \ No newline at end of file