Merge pull request 'Populated README' (#14) from develop into master
Reviewed-on: #14
This commit was merged in pull request #14.
This commit is contained in:
@@ -1 +1,23 @@
|
||||
# LiteCharmsShared
|
||||
# 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`
|
||||
Reference in New Issue
Block a user