Skip to content

Commit ea14700

Browse files
committed
update readme add spirit of the project
1 parent 9df6fc2 commit ea14700

2 files changed

Lines changed: 15 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,15 @@ WebPEER is a Decentralized P2P Network in the Browser. It allows developers to b
66

77
![WebPEER](webpeer.png)
88

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.
12+
913
## Implementation
1014

1115
- [WebPEER.js](https://www.npmjs.com/package/webpeerjs)
1216

13-
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.
1418

1519
## Bootstrapping
1620

@@ -28,11 +32,15 @@ WebPEER Network run over [`libp2p gossipsub`](https://docs.libp2p.io/concepts/se
2832
* ✅ Decentralized
2933
* ✅ True P2P
3034
* ✅ Scalable
31-
* ✅ Use Standard Browser
35+
* ✅ Standard Web
36+
* ✅ Standard Browser
3237
* ✅ Broadcast Channel
3338
* ✅ No Server
3439
* ✅ No Cloud
3540
* ✅ No Admin
41+
* ✅ No Account
42+
* ✅ No Database
43+
* ✅ No Install
3644
* ✅ Freedom
3745

3846
## Ideas
@@ -62,7 +70,7 @@ WebPEER Network run over [`libp2p gossipsub`](https://docs.libp2p.io/concepts/se
6270

6371
## Quickstart
6472

65-
NPM install:
73+
NPM:
6674

6775
```
6876
npm install webpeerjs
@@ -112,19 +120,19 @@ room.onMembers((data) => {
112120

113121
### `peer = await createWebPEER(config)`
114122

115-
Create a new peer node.
123+
Create a new peer.
116124

117125
`config` - Configuration object contains:
118126

119127
- `appName` - Unique application name.
120128

121129
### `peer.id`
122130

123-
Get the unique ID of this peer node.
131+
Get the unique ID of this peer.
124132

125133
### `peer.status`
126134

127-
Get the peer node status, returns `connecting` or `connected`.
135+
Get the peer status, returns `connecting` or `connected`.
128136

129137
- `connecting` - Currently not connected and is trying to connect to the network.
130138
- `connected` - Currently connected to the network.

src/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export const CONFIG_AUTODIAL_MAX_ERROR_LIMIT = 45
2727
export const CONFIG_DIAL_MAX_ERROR_LIMIT = 55
2828
export const CONFIG_DIAL_WEBSOCKET_FIRST = true;
2929
export const CONFIG_DIAL_INCULDE_WEBTRANSPORT = true;
30-
export const CONFIG_ENABLE_PUBSUB_PEER_DISCOVERY = true;
30+
export const CONFIG_ENABLE_PUBSUB_PEER_DISCOVERY = false;
3131

3232
// this list comes from https://github.com/ipfs/kubo/blob/196887cbe5fbcd41243c1dfb0db681a1cc2914ff/config/bootstrap_peers.go
3333
export const CONFIG_KNOWN_DEFAULT_BOOTSTRAP_ADDRESSES = [

0 commit comments

Comments
 (0)