Add: Benchmarks and update README

Author: akshaybharambe14

README.md

@@ -2,26 +2,27 @@
 
 - Decodes a "commented json" to "json". Provided, the input must be a valid jsonc document.
 - Supports io.Reader
+- With this, we can use commented json files as configuration for go applications.
 
 Inspired by [muhammadmuzzammil1998](https://github.com/muhammadmuzzammil1998/jsonc)
 
 ```jsonc
 {
-  /*
+	/*
         some block comment
   */
-  "string": "foo", // a string
-  "bool": false, // a boolean
-  "number": 42, // a number
-  // "object":{
-  //     "key":"val"
-  // },
-  "array": [
-    // example of an array
-    1,
-    2,
-    3
-  ]
+	"string": "foo", // a string
+	"bool": false, // a boolean
+	"number": 42, // a number
+	// "object":{
+	//     "key":"val"
+	// },
+	"array": [
+		// example of an array
+		1,
+		2,
+		3
+	]
 }
 ```
 
@@ -33,7 +34,7 @@ Gets converted to (spaces omitted)
 
 ## Motivation
 
-[jsonc](https://github.com/muhammadmuzzammil1998/jsonc) is great. But this package provides significant performance improvements and simple API to use it with standard library.
+[jsonc](https://github.com/muhammadmuzzammil1998/jsonc) is great. But this package provides significant performance improvements and simple API to use it with standard library. See [benchmarks](https://link)
 
 ## Usage
 
@@ -45,6 +46,26 @@ go get github.com/akshaybharambe14/go-jsonc
 
 ```
 
+## Benchmarks
+
+Here is the performance comparison as compared to [JSONC](https://github.com/muhammadmuzzammil1998/jsonc)
+
+go-jsonc avoids allocations to heap to gain the performance.
+
+```text
+goos: windows
+goarch: amd64
+pkg: github.com/akshaybharambe14/go-jsonc/benchmarks
+BenchmarkOwnSmallJSONBytes-4              256599              4952 ns/op         353.00 MB/s           0 B/op          0 allocs/op
+BenchmarkOwnSmallJSONBytesReader-4        206823              5832 ns/op         299.70 MB/s        6224 B/op          5 allocs/op
+BenchmarkJSONCSmallJSONBytes-4            171474              6925 ns/op         252.41 MB/s        1792 B/op          1 allocs/op
+BenchmarkOwnBigJSONBytes-4                 33517             35921 ns/op         462.26 MB/s           0 B/op          0 allocs/op
+BenchmarkOwnBigJSONBytesReader-4          105244             11292 ns/op        1470.45 MB/s        6224 B/op          5 allocs/op
+BenchmarkJSONCBigJSONBytes-4               19599             61422 ns/op         270.34 MB/s       18432 B/op          1 allocs/op
+PASS
+ok      github.com/akshaybharambe14/go-jsonc/benchmarks 26.250s
+```
+
 ## Example
 
 see [examples](https://github.com/akshaybharambe14/go-jsonc/tree/master/examples)

benchmarks/README.md

@@ -0,0 +1,19 @@
+# Benchmarks
+
+Here is the performance comparison as compared to [jsonc](https://github.com/muhammadmuzzammil1998/jsonc)
+
+go-jsonc avoids allocations to heap to gain the performance.
+
+```
+goos: windows
+goarch: amd64
+pkg: github.com/akshaybharambe14/go-jsonc/benchmarks
+BenchmarkOwnSmallJSONBytes-4              256599              4952 ns/op         353.00 MB/s           0 B/op          0 allocs/op
+BenchmarkOwnSmallJSONBytesReader-4        206823              5832 ns/op         299.70 MB/s        6224 B/op          5 allocs/op
+BenchmarkJSONCSmallJSONBytes-4            171474              6925 ns/op         252.41 MB/s        1792 B/op          1 allocs/op
+BenchmarkOwnBigJSONBytes-4                 33517             35921 ns/op         462.26 MB/s           0 B/op          0 allocs/op
+BenchmarkOwnBigJSONBytesReader-4          105244             11292 ns/op        1470.45 MB/s        6224 B/op          5 allocs/op
+BenchmarkJSONCBigJSONBytes-4               19599             61422 ns/op         270.34 MB/s       18432 B/op          1 allocs/op
+PASS
+ok      github.com/akshaybharambe14/go-jsonc/benchmarks 26.250s
+```

benchmarks/jsonc_bench_test.go

@@ -0,0 +1,77 @@
+package benchmarks
+
+import (
+	"bytes"
+	"io/ioutil"
+	"testing"
+
+	own "github.com/akshaybharambe14/go-jsonc"
+	jsonc "muzzammil.xyz/jsonc"
+)
+
+var jsonBytesSmall, _ = ioutil.ReadFile("./testdata/small.jsonc")
+var jsonBytesBig, _ = ioutil.ReadFile("./testdata/big.jsonc")
+
+func BenchmarkOwnSmallJSONBytes(b *testing.B) {
+	cnt := len(jsonBytesSmall)
+	b.SetBytes(int64(cnt))
+
+	for i := 0; i < b.N; i++ {
+		b.StopTimer()
+
+		ip := make([]byte, cnt)
+		copy(ip, jsonBytesSmall)
+
+		b.StartTimer()
+
+		_, _ = own.DecodeBytes(ip)
+	}
+}
+
+func BenchmarkOwnSmallJSONBytesReader(b *testing.B) {
+	b.SetBytes(int64(len(jsonBytesSmall)))
+
+	for i := 0; i < b.N; i++ {
+		_, _ = ioutil.ReadAll(own.NewDecoder(bytes.NewBuffer(jsonBytesSmall)))
+	}
+}
+
+func BenchmarkJSONCSmallJSONBytes(b *testing.B) {
+	b.SetBytes(int64(len(jsonBytesSmall)))
+
+	for i := 0; i < b.N; i++ {
+		jsonc.ToJSON(jsonBytesSmall)
+	}
+}
+
+func BenchmarkOwnBigJSONBytes(b *testing.B) {
+	cnt := len(jsonBytesBig)
+	b.SetBytes(int64(cnt))
+
+	for i := 0; i < b.N; i++ {
+		b.StopTimer()
+
+		ip := make([]byte, len(jsonBytesBig))
+		copy(ip, jsonBytesBig)
+
+		b.StartTimer()
+
+		_, _ = own.DecodeBytes(ip)
+	}
+}
+
+func BenchmarkOwnBigJSONBytesReader(b *testing.B) {
+	b.SetBytes(int64(len(jsonBytesBig)))
+
+	for i := 0; i < b.N; i++ {
+		_, _ = ioutil.ReadAll(own.NewDecoder(bytes.NewBuffer(jsonBytesBig)))
+	}
+}
+
+func BenchmarkJSONCBigJSONBytes(b *testing.B) {
+	b.SetBytes(int64(len(jsonBytesBig)))
+
+	for i := 0; i < b.N; i++ {
+		_ = jsonc.ToJSON(jsonBytesBig)
+	}
+}