Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PowerUtils.BenchmarkDotnet.Reporter

![Logo](https://raw.githubusercontent.com/TechNobre/PowerUtils.BenchmarkDotnet.Reporter/main/assets/logo/logo_128x128.png)
![Banner](https://raw.githubusercontent.com/TechNobre/PowerUtils.BenchmarkDotnet.Reporter/main/assets/logo/banner.png)

***Tool to analyze and compare .NET benchmark reports***

Expand Down
31 changes: 31 additions & 0 deletions README.nuget.org.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,37 @@
**PowerUtils.BenchmarkDotnet.Reporter** is a command-line tool used to analyze and compare .NET benchmark reports generated by [BenchmarkDotNet](https://www.nuget.org/packages/benchmarkdotnet). This tool is designed to run locally or in CI/CD pipelines, providing a simple way to visualize and compare benchmark results.


## Documentation

- **📖 [Complete Documentation](https://github.com/TechNobre/PowerUtils.BenchmarkDotnet.Reporter/blob/main/README.md)** - Comprehensive guide on installation, usage, commands, and options
- **⚙️ [GitHub Actions Setup Guide](https://github.com/TechNobre/PowerUtils.BenchmarkDotnet.Reporter/blob/main/docs/github-actions-setup.md)** - Step-by-step guide to integrate the tool in your CI/CD pipeline

## Quick Start

### Install the Tool
```bash
dotnet tool install --global PowerUtils.BenchmarkDotnet.Reporter
```

### Basic Usage
```bash
pbreporter compare -b baseline-full.json -t target-full.json -f markdown
```

## CI/CD Integration

Integrate this tool into your GitHub Actions workflow to automatically compare benchmark results on pull requests:

```yaml
- name: Compare Benchmark Results
run: |
pbreporter compare \
-b baseline-report.json \
-t current-report.json \
-f markdown
```

For complete CI/CD setup instructions, see the [GitHub Actions Setup Guide](https://github.com/TechNobre/PowerUtils.BenchmarkDotnet.Reporter/blob/main/docs/github-actions-setup.md).


## Contribution
Expand Down
Binary file added assets/logo/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading