Skip to content

Commit

Permalink
fixed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewI26 committed Dec 25, 2024
1 parent 4cb8605 commit f89831a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions canlink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Currently supported formats are Json and Ascii.
### Usage

1) Create a Bus Manager using `NewBusManager()` function.
A logger, and pointer to a socketcan connection are passed in.
A logger, and pointer to a socketcan connection are passed as arguments.

```go
func main() {
Expand Down Expand Up @@ -51,7 +51,7 @@ Functional options are available of type `TracerOption` if required.
)
}
```
3) Register `Tracer` instance as a handler for the bus manager by calling `Register`, passing in `tracer`. The `broadcast` channel receives frames from the socket connection. The `transmit` channel can be used by handlers to transmit frames onto the CAN bus.
3) Register the `Tracer` instance as a handler for the bus manager by calling `Register`, passing in the `Tracer`. Once started, the manager will send frames from the CAN bus through the broadcast channel to every registered handler. The `transmit` channel can be used by handlers to transmit frames onto the CAN bus.

```go
func main() {
Expand Down

0 comments on commit f89831a

Please sign in to comment.