docs: add README with quick start and docs links
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
parent
6cf51fe8b0
commit
712fe326ff
1 changed files with 43 additions and 0 deletions
43
README.md
Normal file
43
README.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
# go-p2p
|
||||
|
||||
P2P mesh networking layer for the Lethean network. Provides Ed25519 node identity, an encrypted WebSocket transport with HMAC-SHA256 challenge-response handshake, KD-tree peer selection across four dimensions (latency, hops, geography, reliability score), UEPS wire protocol (RFC-021) TLV packet builder and reader, UEPS intent routing with a threat circuit breaker, and TIM deployment bundle encryption with Zip Slip and decompression-bomb defences.
|
||||
|
||||
**Module**: `forge.lthn.ai/core/go-p2p`
|
||||
**Licence**: EUPL-1.2
|
||||
**Language**: Go 1.25
|
||||
|
||||
## Quick Start
|
||||
|
||||
```go
|
||||
import (
|
||||
"forge.lthn.ai/core/go-p2p/node"
|
||||
"forge.lthn.ai/core/go-p2p/ueps"
|
||||
)
|
||||
|
||||
// Start a P2P node
|
||||
identity, _ := node.LoadOrCreateIdentity()
|
||||
transport := node.NewTransport(identity, node.TransportConfig{ListenAddr: ":9091"})
|
||||
transport.Start(ctx)
|
||||
|
||||
// Build a UEPS packet
|
||||
pkt, _ := ueps.NewBuilder(ueps.IntentCompute, payload).MarshalAndSign(sharedSecret)
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Architecture](docs/architecture.md) — node identity, transport, peer registry, UEPS protocol, dispatcher
|
||||
- [Development Guide](docs/development.md) — building, testing, benchmarks, security rules
|
||||
- [Project History](docs/history.md) — completed phases and known limitations
|
||||
|
||||
## Build & Test
|
||||
|
||||
```bash
|
||||
go test ./...
|
||||
go test -race ./...
|
||||
go test -short ./... # skip integration tests
|
||||
go build ./...
|
||||
```
|
||||
|
||||
## Licence
|
||||
|
||||
European Union Public Licence 1.2 — see [LICENCE](LICENCE) for details.
|
||||
Loading…
Add table
Reference in a new issue