Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyredondo committed Jan 16, 2024
1 parent 434e092 commit 3245605
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,42 @@ dotnet tool install --global TimeItSharp
dotnet timeit [configuration file.json]
```

or

```bash
dotnet timeit -- "[command]"
```

```bash
❯ dotnet timeit --help
TimeItSharp v0.1.15
Description:

Usage:
TimeItSharp <configuration file or process name> [options]

Arguments:
<configuration file or process name> The JSON configuration file or process name

Options:
--variable <variable> Variables used to instantiate the configuration file [default: TimeItSharp.Common.TemplateVariables]
--count <count> Number of iterations to run
--warmup <warmup> Number of iterations to warm up
--json-exporter Enable JSON exporter [default: False]
--datadog-exporter Enable Datadog exporter [default: False]
--version Show version information
-?, -h, --help Show help and usage information
```


#### Default Configuration when running a command
```
Warmup count = 1
Count = 10
Exporters = ConsoleExporter
Assertors = DefaultAssertor
```

## Sample Configuration

```json
Expand Down

0 comments on commit 3245605

Please sign in to comment.