From 642b67909bb5861cbe71e15ee29f6818eaf3e0f9 Mon Sep 17 00:00:00 2001 From: Michiel De Backker Date: Fri, 17 Nov 2023 07:42:36 +0100 Subject: [PATCH] Add appetizer to the readme --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 037e2bd..6fe4f39 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,24 @@ # Local Peer-to-Peer API -For the latest proposals, see the [Local Peer-to-Peer API Explainer](EXPLAINER.md). +[Local Peer-to-Peer](https://WICG.github.io/local-peer-to-peer/) is a Web platform API proposal for local communication between browsers without the aid of a server. + +```js +let session = await navigator.lp2p.findPeers(); + +await peer.send("Hello there!"); +``` + +For a more in-dept overview of the proposal, please see the [Explainer](EXPLAINER.md). + +## Status + +This specification is a work in progress. + +## Links + +- [Explainer](EXPLAINER.md) +- [Specification](https://WICG.github.io/local-peer-to-peer/) ## Feedback -We welcome feedback via this GitHub repo issues. Contributions and suggestions to the [Explainer](EXPLAINER.md) are welcome via pull requests too. +We welcome feedback [issue tracker](https://github.com/WICG/local-peer-to-peer/issues) of this GitHub repo. [Contributions](CONTRIBUTING.md) are welcome via pull requests too.