docs: write main documentation

[GregoryAlbouy]

Description

Changes

Notes

Linked issues

• Resolves Re-write main documentation #50

[codecov-commenter]

Codecov Report

Merging #54 (264d89f) into main (be98e9c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #54   +/-   ##
=======================================
  Coverage   73.88%   73.88%           
=======================================
  Files          28       28           
  Lines         873      873           
=======================================
  Hits          645      645           
  Misses        203      203           
  Partials       25       25           

Flag	Coverage Δ
unittests	73.88% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
runner/runner.go	0.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[moreirathomas]

Nitpick: it's not really a lib in the way that it only has one way to be used. I think package don't bring that weight of composability with it.

Suggested change

	Benchttp engine is a Go library providing a way to perform benchmarks and tests
	Benchttp engine is a Go library package a way to perform benchmarks and tests

[c1-ra]

I agree, package sound a little more suitable for me too.

Suggested change

	Benchttp engine is a Go library providing a way to perform benchmarks and tests
	Benchttp engine is a Go package providing a way to perform benchmarks and tests

[GregoryAlbouy]

To me it's still a library, as opposed to an executable application — I felt important to make that clear, as "package" is used for both worlds in Go.

[moreirathomas]

It makes sense too ! I leave judge on that :)

[c1-ra]

I have no strong argument about it either, so OK for library if you prefer it.

[c1-ra]

Nice!

[c1-ra]

👍