Skip to content

fix: Add testing instructions to README.md #243

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
tl-Roberto-Mancinelli merged 2 commits into from
Nov 3, 2025
Merged

fix: Add testing instructions to README.md #243

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41a4159
fix: Add testing instructions to README.md
tl-luca-martinetti May 30, 2025
ad699a5
Merge branch 'main' into improve-readme-testing
tl-Roberto-Mancinelli Nov 3, 2025
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,26 @@ public class MyService

For more examples see the [API documentation](https://docs.truelayer.com). Advanced customization options and documentation for contributors can be found in the [Wiki](https://github.com/TrueLayer/truelayer-sdk-net/wiki).

## Testing

This project includes two types of tests:

**Unit Tests** - Run standalone without external dependencies:
```shell
dotnet test test/TrueLayer.Tests/
```

**Acceptance Tests** - End-to-end integration tests that require TrueLayer sandbox credentials:
```shell
# Set credentials via environment variables
TrueLayer__ClientId=your_client_id TrueLayer__ClientSecret=your_client_secret dotnet test

# Or run all tests (will fail without credentials)
dotnet test
```

The acceptance tests make real HTTP calls to TrueLayer's sandbox APIs to validate the entire SDK against live services. See `test/TrueLayer.AcceptanceTests/README.md` for credential setup instructions.

## Building locally

This project uses [Cake](https://cakebuild.net/) to build, test and publish packages.
Expand Down