From 382e67b96ea09dc8e67c1738c93da1296c4a492c Mon Sep 17 00:00:00 2001 From: Nasir Hossain Date: Tue, 12 Aug 2025 09:25:48 +0600 Subject: [PATCH] chore(readme): add context and improve formatting --- .prettierrc | 4 ++++ README.md | 21 +++++++++++++++------ 2 files changed, 19 insertions(+), 6 deletions(-) create mode 100644 .prettierrc diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..0f1d058 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,4 @@ +{ + "printWidth": 80, + "proseWrap": "always" +} \ No newline at end of file diff --git a/README.md b/README.md index fa12089..c0f8345 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,19 @@ # Betanet Layer Prototype (L1, L2, L3, L5) -**Quick prototype of Betanet layers L1, L2, L3, and L5** implemented as an asyncio simulation. -This is for educational/demo purposes only — **not** production-ready code. +**Quick prototype of Betanet layers L1, L2, L3, and L5** implemented as an +asyncio simulation. This is for educational/demo purposes only — **not** +production-ready code. If you don't now what it's all about, check out the +following links for context: + +- [Developers, I need your help. I made a new internet - K0](https://youtu.be/sTzBO_BliZ8) +- [Explaining Betanet - K0](https://youtu.be/L1Hjen1tEas) +- [The Betanet Specification](https://github.com/ravendevteam/betanet) ## Disclaimer -This simulation **does not** use real Ed25519/X25519 cryptography. -Crypto functions are stubbed with hash/HMAC placeholders to keep it simple and dependency-light. +This simulation **does not** use real Ed25519/X25519 cryptography. Crypto +functions are stubbed with hash/HMAC placeholders to keep it simple and +dependency-light. For better implementations, replace the placeholder crypto in: @@ -35,8 +42,10 @@ with real libraries like: ## Features - **Path building & validation (L1)** — verifies AS hop signatures before use. -- **HTX transport sessions (L2)** — simulates TLS/QUIC-like outer wrapping with inner encrypted frames. -- **Overlay network (L3)** — publish & retrieve content by CID from connected peers. +- **HTX transport sessions (L2)** — simulates TLS/QUIC-like outer wrapping with + inner encrypted frames. +- **Overlay network (L3)** — publish & retrieve content by CID from connected + peers. - **Alias ledger (L5)** — map human-readable aliases to self-certifying IDs. ---