Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Bikeshed setup #21

Merged
merged 4 commits into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Build
on:
pull_request: {}
push:
branches:
- main
permissions:
contents: write
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: w3c/spec-prod@v2
with:
TOOLCHAIN: bikeshed
SOURCE: index.bs
DESTINATION: index.html
GH_PAGES_BRANCH: gh-pages
BUILD_FAIL_ON: warning
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
index.html
8 changes: 8 additions & 0 deletions .pr-preview.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"src_file": "index.bs",
"type": "bikeshed",
"params": {
"force": 1
}
}

27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
# Authors
- Anssi Kostiainen (Intel)
- Belem Zhang (Intel)
- Wei Wang (Intel)

# 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 peers = await navigator.lp2p.findPeers();
let peer = peers[0];
await peer.connect();
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 via the [issue tracker](https://github.com/WICG/local-peer-to-peer/issues) of this GitHub repo. [Contributions](CONTRIBUTING.md) are welcome via pull requests too.
20 changes: 20 additions & 0 deletions index.bs
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<pre class='metadata'>
Title: Local Peer-to-Peer API
Shortname: local-peer-to-peer
Level: 1
Status: CG-DRAFT
Group: WICG
Repository: WICG/local-peer-to-peer
URL: https://WICG.github.io/local-peer-to-peer/
Editor: Anssi Kostiainen, Intel https://intel.com, [email protected]
Editor: Belem Zhang, Intel https://intel.com, [email protected]
Editor: Michiel De Backker, Twintag https://twintag.com, [email protected]
Editor: Wei Wang, Intel https://intel.com, [email protected]
!Tests: <a href=https://github.com/w3c/web-platform-tests/tree/master/local-peer-to-peer>web-platform-tests local-peer-to-peer/</a> (<a href=https://github.com/w3c/web-platform-tests/labels/local-peer-to-peer>ongoing work</a>)
Abstract: Local Peer-to-Peer is a Web platform API proposal for local communication between browsers without the aid of a server.
</pre>

Introduction {#intro}
=====================

*This section is non-normative.*