Skip to content

Commit

Permalink
Add appetizer to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
backkem committed Nov 21, 2023
1 parent ca850af commit 642b679
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 642b679

Please sign in to comment.