Skip to content

Commit c3a5e4e

Browse files
Update C# README (#258)
1 parent 9c9d03a commit c3a5e4e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

examples/benchmarkdotnet/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@ C# example for benchmarking with `Benchmark.Net`
22
================================================
33

44
- [Workflow for this example](../../.github/workflows/benchmarkdotnet.yml)
5-
- [Action log of this example](https://github.com/rhysd/github-action-benchmark/actions?query=workflow%3A%22Benchmark.Net+example%22)
5+
- [Action log of this example](https://github.com/benchmark-action/github-action-benchmark/actions?query=workflow%3A%22Benchmark.Net+example%22)
66
- [Benchmark results on GitHub pages](https://benchmark-action.github.io/github-action-benchmark/dev/bench/)
77

8-
This directory shows how to use [`github-action-benchmark`](https://github.com/rhysd/github-action-benchmark)
9-
with [`Benchmark.Net`](https://benchmarkdotnet.org/).
8+
This directory shows how to use [`github-action-benchmark`](https://github.com/benchmark-action/github-action-benchmark)
9+
with [`BenchmarkDotNet`](https://benchmarkdotnet.org/).
1010

1111
## Run benchmarks
1212

13-
Official documentation for usage of `Benchmark.Net`:
13+
Official documentation for usage of `BenchmarkDotNet`:
1414

1515
https://benchmarkdotnet.org/articles/overview.html
1616

17-
You should add the `Benchmark.Net` package to your test project and configure your tests according to the [Getting Started](https://benchmarkdotnet.org/articles/guides/getting-started.html) docs. A simple test file might look like
17+
You should add the `BenchmarkDotNet` package to your test project and configure your tests according to the [Getting Started](https://benchmarkdotnet.org/articles/guides/getting-started.html) docs. A simple test file might look like
1818

1919

2020
```csharp
@@ -64,7 +64,7 @@ You can then run the tests using `dotnet run`. It's _very_ important that you e
6464

6565
Store the benchmark results with step using the action. Please set `benchmarkdotnet` to `tool` input.
6666

67-
By default, Benchmark.Net will output results files to the current directory in a structure like:
67+
By default, BenchmarkDotNet will output results files to the current directory in a structure like:
6868

6969
```
7070
BenchmarkDotNet.Artifacts
@@ -81,10 +81,10 @@ You want to get the path of the `-report-full-compressed.json` report for use wi
8181

8282
```yaml
8383
- name: Store benchmark result
84-
uses: rhysd/github-action-benchmark@v1
84+
uses: benchmark-action/github-action-benchmark@v1
8585
with:
8686
tool: 'benchmarkdotnet'
8787
output-file-path: BenchmarkDotNet.Artifacts/results/Sample.Benchmarks-report-full-compressed.json
8888
```
8989
90-
Please read ['How to use' section](https://github.com/rhysd/github-action-benchmark#how-to-use) for common usage.
90+
Please read [How to use section](https://github.com/benchmark-action/github-action-benchmark#how-to-use) for common usage.

0 commit comments

Comments
 (0)