Skip to content

Commit

Permalink
Update README.md (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
jjti committed Feb 13, 2024
1 parent cae4511 commit 0bf80bc
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -10,13 +10,6 @@ Checks usage of:
- [OpenTelemetry spans](https://opentelemetry.io/docs/instrumentation/go/manual/) from [go.opentelemetry.io/otel/trace](go.opentelemetry.io/otel/trace)
- [OpenCensus spans](https://opencensus.io/quickstart/go/tracing/) from [go.opencensus.io/trace](https://pkg.go.dev/go.opencensus.io/trace#Span)

## Installation & Usage

```bash
go install github.com/jjti/go-spancheck/cmd/spancheck@latest
spancheck ./...
```

## Example

```bash
Expand Down Expand Up @@ -74,6 +67,13 @@ linters-settings:

### CLI

To install the linter as a CLI:

```bash
go install github.com/jjti/go-spancheck/cmd/spancheck@latest
spancheck ./...
```

Only the `span.End()` check is enabled by default. The others can be enabled with `-checks 'end,set-status,record-error'`.

```txt
Expand Down

0 comments on commit 0bf80bc

Please sign in to comment.