You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,15 @@ WebPEER is a Decentralized P2P Network in the Browser. It allows developers to b
6
6
7
7

8
8
9
+
## Spirit
10
+
11
+
In the early days of the World Wide Web, the internet was more open and more like a peer-to-peer network, where every user had equal standing on the network. This project aims to restore that early spirit through web standards, so that no single entity controls the network. However, the reality that standard web browsers have many limitations makes this dream a significant challenge. WebPEER seeks to address these challenges to see what is possible on today's web by reusing already invented components.
JavaScript implementation of WebPEER Network designed as a minimal, essential API. It uses IPFS and the libp2p modular stack for the specific purpose of propagating messages over the network via direct WebRTC connections between browsers. As a result, these messages can arrive asynchronously depending on how many iterations they have gone through.
17
+
The JavaScript implementation of WebPEER Network designed as a minimal, essential API. It uses IPFS and the libp2p modular stack for the specific purpose of propagating messages over the network via direct WebRTC connections between browsers. The consequence is that these messages can arrive asynchronously depending on how many iterations they have gone through.
14
18
15
19
## Bootstrapping
16
20
@@ -28,11 +32,15 @@ WebPEER Network run over [`libp2p gossipsub`](https://docs.libp2p.io/concepts/se
28
32
* ✅ Decentralized
29
33
* ✅ True P2P
30
34
* ✅ Scalable
31
-
* ✅ Use Standard Browser
35
+
* ✅ Standard Web
36
+
* ✅ Standard Browser
32
37
* ✅ Broadcast Channel
33
38
* ✅ No Server
34
39
* ✅ No Cloud
35
40
* ✅ No Admin
41
+
* ✅ No Account
42
+
* ✅ No Database
43
+
* ✅ No Install
36
44
* ✅ Freedom
37
45
38
46
## Ideas
@@ -62,7 +70,7 @@ WebPEER Network run over [`libp2p gossipsub`](https://docs.libp2p.io/concepts/se
62
70
63
71
## Quickstart
64
72
65
-
NPM install:
73
+
NPM:
66
74
67
75
```
68
76
npm install webpeerjs
@@ -112,19 +120,19 @@ room.onMembers((data) => {
112
120
113
121
### `peer = await createWebPEER(config)`
114
122
115
-
Create a new peer node.
123
+
Create a new peer.
116
124
117
125
`config` - Configuration object contains:
118
126
119
127
-`appName` - Unique application name.
120
128
121
129
### `peer.id`
122
130
123
-
Get the unique ID of this peer node.
131
+
Get the unique ID of this peer.
124
132
125
133
### `peer.status`
126
134
127
-
Get the peer node status, returns `connecting` or `connected`.
135
+
Get the peer status, returns `connecting` or `connected`.
128
136
129
137
-`connecting` - Currently not connected and is trying to connect to the network.
130
138
-`connected` - Currently connected to the network.
0 commit comments