From 19e35eae5bce80938ff5c0365276c97d5f7a21b6 Mon Sep 17 00:00:00 2001 From: Chrison Simtian Date: Fri, 24 Jul 2026 00:18:03 +1200 Subject: [PATCH 1/2] docs(readme): add Built-with-Fallout badge + Building section - New 'Built with Fallout' badge; relabel the CI badge 'Build & Test' (build.yml runs the *.Specs suite + Pack). - Add a Building section documenting the Fallout build (./build.ps1 Test/Pack/Generate). - Downloads badge (nuget/dt) already present. Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7cb69df..37cfc5a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ [![NuGet](https://img.shields.io/nuget/v/TvdbClient.svg)](https://www.nuget.org/packages/TvdbClient/) [![Downloads](https://img.shields.io/nuget/dt/TvdbClient.svg)](https://www.nuget.org/packages/TvdbClient/) -[![Build](https://github.com/Chrison-dev/TvdbApi/actions/workflows/build.yml/badge.svg)](https://github.com/Chrison-dev/TvdbApi/actions/workflows/build.yml) +[![Build & Test](https://github.com/Chrison-dev/TvdbApi/actions/workflows/build.yml/badge.svg)](https://github.com/Chrison-dev/TvdbApi/actions/workflows/build.yml) +[![Built with Fallout](https://img.shields.io/badge/built%20with-Fallout-8A2BE2)](https://github.com/ChrisonSimtian/Fallout) [![License](https://img.shields.io/github/license/Chrison-dev/TvdbApi.svg)](LICENSE) A C# `HttpClient`-based API client for [TheTVDB](https://thetvdb.com) **v4 API**. @@ -70,10 +71,22 @@ var response = await series.SeriesGetAsync(121361); // ids are long var record = response.Data; // { data, status } envelope ``` +## Building + +This project builds with **[Fallout](https://github.com/ChrisonSimtian/Fallout)** +(a NUKE fork) — the build lives in `build/Build.cs` and runs through the `./build.ps1` +bootstrapper (no global tool required). CI (`build.yml`) invokes the same targets. + +```sh +./build.ps1 Test # run the *.Specs test suite +./build.ps1 Pack # produce the three NuGet packages in artifacts/packages +./build.ps1 Generate # regenerate the client + models from TheTVDB's OpenAPI spec +``` + ## Regenerating the models -Models + clients are generated from TheTVDB's OpenAPI spec via the -[Fallout](https://github.com/ChrisonSimtian/Fallout) build (NSwag under the hood): +Models + clients are generated from TheTVDB's OpenAPI spec via the Fallout +`Generate` target (NSwag under the hood): ```sh ./build.ps1 Generate From 080337c9881fdf982c19367aea3f8c8a7fcece48 Mon Sep 17 00:00:00 2001 From: Chrison Simtian Date: Fri, 24 Jul 2026 00:26:24 +1200 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 37cfc5a..c67c9c8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![NuGet](https://img.shields.io/nuget/v/TvdbClient.svg)](https://www.nuget.org/packages/TvdbClient/) [![Downloads](https://img.shields.io/nuget/dt/TvdbClient.svg)](https://www.nuget.org/packages/TvdbClient/) [![Build & Test](https://github.com/Chrison-dev/TvdbApi/actions/workflows/build.yml/badge.svg)](https://github.com/Chrison-dev/TvdbApi/actions/workflows/build.yml) -[![Built with Fallout](https://img.shields.io/badge/built%20with-Fallout-8A2BE2)](https://github.com/ChrisonSimtian/Fallout) +[![Built with Fallout](https://img.shields.io/badge/built%20with-Fallout-8A2BE2)](https://github.com/Fallout-build/Fallout) [![License](https://img.shields.io/github/license/Chrison-dev/TvdbApi.svg)](LICENSE) A C# `HttpClient`-based API client for [TheTVDB](https://thetvdb.com) **v4 API**.