You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -177,7 +177,7 @@ go get -u github.com/bsv-blockchain/go-p2p-message-bus
177
177
## 📚 Documentation
178
178
179
179
-**API Reference** – Dive into the godocs at [pkg.go.dev/github.com/bsv-blockchain/go-p2p-message-bus](https://pkg.go.dev/github.com/bsv-blockchain/go-p2p-message-bus)
180
-
-**Usage Examples** – Browse practical patterns either the [examples directory](example) or the example tests
180
+
-**Usage Examples** – Browse practical patterns either the [examples directory](cmd/example) or the example tests
181
181
-**Benchmarks** – Check the latest numbers in the benchmark results
182
182
-**Test Suite** – Review both the unit tests and fuzz tests (powered by [`testify`](https://github.com/stretchr/testify))
All unit tests and [examples](example) run via [GitHub Actions](https://github.com/bsv-blockchain/go-p2p-message-bus/actions) and use [Go version 1.24.x](https://go.dev/doc/go1.24). View the [configuration file](.github/workflows/fortress.yml).
566
+
All unit tests and [examples](cmd/example) run via [GitHub Actions](https://github.com/bsv-blockchain/go-p2p-message-bus/actions) and use [Go version 1.24.x](https://go.dev/doc/go1.24). View the [configuration file](.github/workflows/fortress.yml).
567
567
568
568
Run all tests (fast):
569
569
@@ -580,20 +580,18 @@ magex test:race
580
580
<summary><strong><code>Running the Example</code></strong></summary>
581
581
<br/>
582
582
583
-
See [example/main.go](example/main.go) for a complete working example.
583
+
See [cmd/example/main.go](cmd/example/main.go) for a complete working example.
584
584
585
585
To run the example:
586
586
587
587
```bash
588
-
cd example
589
-
go run main.go -name "node1"
588
+
go run ./cmd/example -name "node1"
590
589
```
591
590
592
591
In another terminal:
593
592
594
593
```bash
595
-
cd example
596
-
go run main.go -name "node2"
594
+
go run ./cmd/example -name "node2"
597
595
```
598
596
599
597
The two nodes will discover each other and exchange messages.
0 commit comments