Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jpalcala committed Feb 16, 2018
1 parent 9b87935 commit f32d792
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Repeating code and reinventing the wheel is generally considered bad practice. A
* [The ArgumentParser component](#the-argumentparser-component)
* [The SettingsProvider abstraction](#the-settingsprovider-abstraction)
* [The Connection class](#the-connection-class)
* [The Benchmark component](#the-benchmark-component)

## Libraries
We offer the Swan library in two flavors since version 0.24. Swan Lite provides basic classes and extension methods and Swan Standard (we call it Fat Swan) provides everything in Swan Lite plus Network, WinServices, DI and more. See the following table to understand the components available to these flavors of Swan.
Expand Down Expand Up @@ -968,3 +969,20 @@ using (var cn = new Connection(client, Encoding.UTF8, "\r\n", true, 0))
var response = await cn.ReadTextAsync();
}
```

### The `Benchmark` component
A simple benchmarking tool that provides useful statistics about a certain piece of code.

#### Example 1: A simple benchmark test
```csharp
//starts a test with a custom name identifier
using (Benchmark.Start("Test"))
{

// do some logic in here
}

// dump results into a string
var results = Benchmark.Dump();
```

0 comments on commit f32d792

Please sign in to comment.