Skip to content

docs(readme): Built-with-Fallout badge + Building section #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisonSimtian merged 2 commits into from
Jul 23, 2026
Merged

docs(readme): Built-with-Fallout badge + Building section #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19e35ea
docs(readme): add Built-with-Fallout badge + Building section
ChrisonSimtian Jul 23, 2026
080337c
Update README.md
ChrisonSimtian Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/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**.
Expand Down Expand Up @@ -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
Expand Down
Loading