From 86439d5147e65c8fe79437f7b0b07408a5ffa824 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 13 May 2026 21:27:36 +0000 Subject: [PATCH] docs: add NuGet package info to README files and update copilot instructions Agent-Logs-Url: https://github.com/tgoessler/TCSystemCS/sessions/78a21a1b-e660-4343-8eb0-b4f4de0e8435 Co-authored-by: tgoessler <89462205+tgoessler@users.noreply.github.com> --- .github/copilot-instructions.md | 2 ++ Gps/README.md | 8 ++++++++ Logging/README.md | 8 ++++++++ MetaData/README.md | 8 ++++++++ MetaDataDB/README.md | 8 ++++++++ README.md | 19 ++++++++----------- Thread/README.md | 8 ++++++++ Util/README.md | 8 ++++++++ 8 files changed, 58 insertions(+), 11 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 1c39336..7247bb5 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -15,7 +15,9 @@ TCSystemCS is a collection of reusable .NET libraries written in **C# 14** targe ├── MetaDataDB/ → TCSystem.MetaDataDB (SQLite metadata storage) │ └── Tests/ → TCSystem.MetaDataDB.Tests (NUnit) ├── Thread/ → TCSystem.Thread (worker thread, async helpers) +│ └── Tests/ → TCSystem.Thread.Tests (NUnit) ├── Util/ → TCSystem.Util (extension methods, utilities) +│ └── Tests/ → TCSystem.Util.Tests (NUnit) └── Tools/ ├── DBConverter/ → Console app – database schema converter └── TakeoutReader/→ Console app – Google Takeout importer diff --git a/Gps/README.md b/Gps/README.md index aca55fb..046779d 100644 --- a/Gps/README.md +++ b/Gps/README.md @@ -1,7 +1,15 @@ # TCSystem.Gps +[![NuGet](https://img.shields.io/nuget/v/TCSystem.Gps.svg)](https://www.nuget.org/packages/TCSystem.Gps/) + Reader for GPS data from Google Takeout location history files (`records.json`). Uses `System.Text.Json` with async streaming for efficient processing of large files. +## Installation + +```bash +dotnet add package TCSystem.Gps +``` + ## Features - Async streaming reader for Google Takeout `records.json` diff --git a/Logging/README.md b/Logging/README.md index 65d5470..8424e74 100644 --- a/Logging/README.md +++ b/Logging/README.md @@ -1,7 +1,15 @@ # TCSystem.Logging +[![NuGet](https://img.shields.io/nuget/v/TCSystem.Logging.svg)](https://www.nuget.org/packages/TCSystem.Logging/) + Wraps [Serilog](https://serilog.net/) behind an abstract `Logger` class where debug logging is **not compiled** into your code when building in Release mode (using `[Conditional("DEBUG")]`). +## Installation + +```bash +dotnet add package TCSystem.Logging +``` + ## Features - Abstract `Logger` class with conditional debug logging diff --git a/MetaData/README.md b/MetaData/README.md index eb9382e..eb089e6 100644 --- a/MetaData/README.md +++ b/MetaData/README.md @@ -1,7 +1,15 @@ # TCSystem.MetaData +[![NuGet](https://img.shields.io/nuget/v/TCSystem.MetaData.svg)](https://www.nuget.org/packages/TCSystem.MetaData/) + Classes for handling and storing image metadata including date/time, GPS location, and face/person tags. Supports JSON serialization via Newtonsoft.Json. +## Installation + +```bash +dotnet add package TCSystem.MetaData +``` + ## Features - Immutable data models for image metadata diff --git a/MetaDataDB/README.md b/MetaDataDB/README.md index 66cb9ca..9557085 100644 --- a/MetaDataDB/README.md +++ b/MetaDataDB/README.md @@ -1,7 +1,15 @@ # TCSystem.MetaDataDB +[![NuGet](https://img.shields.io/nuget/v/TCSystem.MetaDataDB.svg)](https://www.nuget.org/packages/TCSystem.MetaDataDB/) + SQLite database abstraction for storing, querying, and filtering image metadata. Provides thread-safe access through an instance-pooling pattern. +## Installation + +```bash +dotnet add package TCSystem.MetaDataDB +``` + ## Features - SQLite-based persistent storage for image metadata diff --git a/README.md b/README.md index 4e25bfe..76e1392 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,14 @@ A collection of reusable .NET libraries for logging, image metadata management, ## Libraries -### [TCSystem.Util](Util/README.md) - -### [TCSystem.Logging](Logging/README.md) - -### [TCSystem.MetaData](MetaData/README.md) - -### [TCSystem.MetaDataDB](MetaDataDB/README.md) - -### [TCSystem.Gps](Gps/README.md) - -### [TCSystem.Thread](Thread/README.md) +| Package | NuGet | +|---------|-------| +| [TCSystem.Util](Util/README.md) | [![NuGet](https://img.shields.io/nuget/v/TCSystem.Util.svg)](https://www.nuget.org/packages/TCSystem.Util/) | +| [TCSystem.Logging](Logging/README.md) | [![NuGet](https://img.shields.io/nuget/v/TCSystem.Logging.svg)](https://www.nuget.org/packages/TCSystem.Logging/) | +| [TCSystem.MetaData](MetaData/README.md) | [![NuGet](https://img.shields.io/nuget/v/TCSystem.MetaData.svg)](https://www.nuget.org/packages/TCSystem.MetaData/) | +| [TCSystem.MetaDataDB](MetaDataDB/README.md) | [![NuGet](https://img.shields.io/nuget/v/TCSystem.MetaDataDB.svg)](https://www.nuget.org/packages/TCSystem.MetaDataDB/) | +| [TCSystem.Gps](Gps/README.md) | [![NuGet](https://img.shields.io/nuget/v/TCSystem.Gps.svg)](https://www.nuget.org/packages/TCSystem.Gps/) | +| [TCSystem.Thread](Thread/README.md) | [![NuGet](https://img.shields.io/nuget/v/TCSystem.Thread.svg)](https://www.nuget.org/packages/TCSystem.Thread/) | ## Tools diff --git a/Thread/README.md b/Thread/README.md index 9429ef8..5ac75e8 100644 --- a/Thread/README.md +++ b/Thread/README.md @@ -1,7 +1,15 @@ # TCSystem.Thread +[![NuGet](https://img.shields.io/nuget/v/TCSystem.Thread.svg)](https://www.nuget.org/packages/TCSystem.Thread/) + Thread helper classes including a worker thread that queues commands and executes them in order. Supports async `Task`-based APIs and cancellation tokens. +## Installation + +```bash +dotnet add package TCSystem.Thread +``` + ## Features - Worker thread with command queue (FIFO execution) diff --git a/Util/README.md b/Util/README.md index 7461861..d1d393e 100644 --- a/Util/README.md +++ b/Util/README.md @@ -1,7 +1,15 @@ # TCSystem.Util +[![NuGet](https://img.shields.io/nuget/v/TCSystem.Util.svg)](https://www.nuget.org/packages/TCSystem.Util/) + Lightweight extension methods for containers, enumerables, and common patterns such as null-safe equality comparisons. +## Installation + +```bash +dotnet add package TCSystem.Util +``` + ## Features - Extension methods for collections and enumerables