Update README.md

2022-08-23 00:36:58 +02:00 · 2022-08-23 00:36:58 +02:00 · be366b56bc
--- a/README.md
+++ b/README.md
@ -1 +1,139 @@
-# nanoFramework.Benchmark
+# nanoFramework.Benchmark
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/nanoframework/Home/blob/main/CONTRIBUTING.md) [![Discord](https://img.shields.io/discord/478725473862549535.svg?logo=discord&logoColor=white&label=Discord&color=7289DA)](https://discord.gg/gCyBu8T)
+
+![nanoFramework logo](https://raw.githubusercontent.com/nanoframework/Home/main/resources/logo/nanoFramework-repo-logo.png)
+
+-----
+
+# Welcome to the .NET **nanoFramework** Benchmark repository
+## What is the .NET **nanoFramework** Benchmark
+The nanoFramework.Benchmark tool helps you to measure and track performance of the nanoFramework code. 
+You can easily turn normal method into benchmark by just adding one attribute!
+
+Heavily inspired by [BenchmarkDotNet](https://github.com/dotnet/BenchmarkDotNet).
+
+Example bellow will:
+1. Run Setup method once before running any benchmark method.
+2. Run each benchmark method 10 time.
+3. Prepare data to be passed into each parses.
+4. Invoke ConsoleParser (prints data in console as table).
+
+```csharp
+public class CompareObjectTypesBenchmark
+{
+    object[] array;
+
+    [Setup]
+    public void Setup()
+    {
+        array = new object[] {
+                    (int)42,
+                    (byte)42,
+                    "This is a super string",
+                    (ulong)42,
+                    new Version(4, 2)
+                };
+    }
+
+    [Benchmark]
+    public void CompareByString()
+    {
+        for (int i = 0; i < array.Length; i++)
+        {
+            object obja = array.GetValue(i);
+            var typea = obja.GetType();
+            CompareUsingString(typea);
+        }
+    }
+
+    [Benchmark]
+    public void CompareUsingTypeofIf()
+    {
+        for (int i = 0; i < array.Length; i++)
+        {
+            object obja = array.GetValue(i);
+            var typea = obja.GetType();
+            CompareUsingTypeofIf(typea);
+        }
+    }
+
+    [Benchmark]
+    public void CompareUsingTypeofIfReturn()
+    {
+        for (int i = 0; i < array.Length; i++)
+        {
+            object obja = array.GetValue(i);
+            var typea = obja.GetType();
+            CompareUsingTypeofIfReturn(typea);
+        }
+    }
+}
+```
+
+Output:
+```
+Console export: CompareObjectTypesBenchmark benchmark class.
+| MethodName                 | ItterationCount | Mean  | Min   | Max   |
+| -------------------------------------------------------------------- |
+| CompareByString            | 10              | 10 ms | 10 ms | 10 ms |
+| CompareUsingTypeofIf       | 10              | 3 ms  | 0 ms  | 10 ms |
+| CompareUsingTypeofIfReturn | 10              | 5 ms  | 0 ms  | 10 ms |
+```
+
+## Attributes
+### Class
+#### IterationCount
+Specify how many times each benchmark method needs to be invoked when running benchmark methods. Default is 10.
+
+-----
+### Logger
+Sometimes you can try something that benchmark library does not support. In such situation, instead of debugging code, you may inject logger object. 
+#### DebugLogger
+Wrapper around nanoFramework.Logging.Debug. Prints logs to console.
+
+### Methods
+#### Setup
+SetupAttribute is used to specify which method should be invoked only once before running benchmark methods.
+It can be used to initialize collections/objects etc. 
+The execution time of setup method is not taken into account when calculating benchmark results.
+
+Note, that setup method must be public and without parameters.
+
+#### Benchmark
+BenchmarkAttribute is used to specify which method should be invoked as benchmark. 
+
+Note, that benchmark method must be public and without parameters.
+
+-----
+### Parsers
+You can specify parsers as attributes on class. Every parsers is invoked after benchmark run, so you can get results in multiple formats.  
+
+By default only ConsoleParser is applied. 
+
+New parses can be easily implement by creating new class and implementing IResultParses interface. Also new attribute needs to be  
+
+#### ConsoleParser
+You can use **CsvParserAttribute** to add parser which prints data in console in table format.
+
+Output example
+```
+Console export: CompareObjectTypesBenchmark benchmark class.
+| MethodName                 | ItterationCount | Mean   | Min  | Max   |
+| -------------------------------------------------------------------- |
+| CompareByString            | 100             | 8.9 ms | 0 ms | 10 ms |
+| CompareUsingTypeofIf       | 100             | 4.1 ms | 0 ms | 10 ms |
+| CompareUsingTypeofIfReturn | 100             | 4.2 ms | 0 ms | 10 ms |
+```
+
+#### CsvParser
+You can use **CsvParserAttribute** to add parser which prints data in console in CSV format.
+
+Output example
+```
+CSV export: CompareObjectTypesBenchmark benchmark class.
+MethodName;ItterationCount;Mean;Min;Max
+CompareByString;100;8.9 ms;0 ms;10 ms
+CompareUsingTypeofIf;100;4.1 ms;0 ms;10 ms
+CompareUsingTypeofIfReturn;100;4.2 ms;0 ms;10 ms
+```