diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..0352427 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,8 @@ +.gitattributes export-ignore +.gitignore export-ignore +.travis.yml export-ignore + +Makefile export-ignore + +*.md export-ignore +*_test.go export-ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..414091c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# code coverage and quality reports +*.out diff --git a/README.md b/README.md index 1c1bc5e..d601b7f 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ allocates at call stack: 1, detailed call stack: ## 🧩 Integration -This library uses [SemVer](https://semver.org/) for versioning, and it is not +The library uses [SemVer](https://semver.org) for versioning, and it is not [BC](https://en.wikipedia.org/wiki/Backward_compatibility)-safe through major releases. You can use [dep][] or [go modules][gomod] to manage its version. diff --git a/tracer.go b/tracer.go index a03d52b..a9676be 100644 --- a/tracer.go +++ b/tracer.go @@ -16,7 +16,7 @@ type Trace struct { // Start creates a call entry and marks its start time. // // func Do(ctx context.Context) { -// call := tracer.Fetch(ctx).Start() +// call := tracer.Fetch(ctx).Start("id", "labelX", "labelY") // defer call.Stop() // } //