Skip to content

Commit ed93657

Browse files
committed
Remove main application file for P2P messaging example
1 parent 095acc8 commit ed93657

File tree

5 files changed

+6
-899
lines changed

5 files changed

+6
-899
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ go get -u github.com/bsv-blockchain/go-p2p-message-bus
177177
## 📚 Documentation
178178

179179
- **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
181181
- **Benchmarks** – Check the latest numbers in the benchmark results
182182
- **Test Suite** – Review both the unit tests and fuzz tests (powered by [`testify`](https://github.com/stretchr/testify))
183183

@@ -563,7 +563,7 @@ Uses GossipSub for efficient topic-based message propagation:
563563

564564
## 🧪 Examples & Tests
565565

566-
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).
567567

568568
Run all tests (fast):
569569

@@ -580,20 +580,18 @@ magex test:race
580580
<summary><strong><code>Running the Example</code></strong></summary>
581581
<br/>
582582

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.
584584

585585
To run the example:
586586

587587
```bash
588-
cd example
589-
go run main.go -name "node1"
588+
go run ./cmd/example -name "node1"
590589
```
591590

592591
In another terminal:
593592

594593
```bash
595-
cd example
596-
go run main.go -name "node2"
594+
go run ./cmd/example -name "node2"
597595
```
598596

599597
The two nodes will discover each other and exchange messages.

codecov.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ ignore:
3131
- ".mage-cache/**"
3232
- ".vscode/**"
3333
- "bin/**"
34-
- "example/**"
34+
- "cmd/**"
3535
- "examples/**"
3636
- "mocks/**"
3737
- "testing/**"

example/go.mod

Lines changed: 0 additions & 126 deletions
This file was deleted.

0 commit comments

Comments
 (0)