Skip to content

Commit 93cba0f

Browse files
authored
docs: update README.md
1 parent 70b13c4 commit 93cba0f

File tree

1 file changed

+24
-28
lines changed

1 file changed

+24
-28
lines changed

README.md

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<a href="https://libp2p.io">
3-
<img width="250" src="https://github.com/libp2p/js-libp2p/blob/master/img/libp2p.png?raw=true" alt="libp2p hex logo" />
3+
<img width="250" src="https://github.com/libp2p/js-libp2p/blob/main/img/libp2p.png?raw=true" alt="libp2p hex logo" />
44
</a>
55
</p>
66

@@ -18,14 +18,12 @@
1818

1919
## Table of Contents
2020

21-
- [Table of Contents](#table-of-contents)
2221
- [About The Project](#about-the-project)
2322
- [Getting Started](#getting-started)
24-
- [Examples](#examples)
25-
- [Understanding how libp2p works](#understanding-how-libp2p-works)
26-
- [Other examples](#other-examples)
27-
- [libp2p in the Browser](#libp2p-in-the-browser)
2823
- [Prerequisites](#prerequisites)
24+
- [Understanding how libp2p works](#understanding-how-libp2p-works)
25+
- [Other examples](#other-examples)
26+
- [libp2p in browsers](#libp2p-in-browsers)
2927
- [Documentation](#documentation)
3028
- [Contribute](#contribute)
3129
- [License](#license)
@@ -42,59 +40,57 @@
4240

4341
## Getting Started
4442

45-
### Examples
46-
4743
Feel free to jump directly into the examples, however going through the following sections will help build context and background knowledge.
4844

49-
#### Understanding how libp2p works
45+
### Prerequisites
46+
47+
Make sure you have installed all of the following prerequisites on your development machine:
48+
49+
- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
50+
- Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
51+
52+
### Understanding how libp2p works
5053

5154
- [Circuit Relay](https://github.com/libp2p/js-libp2p-example-circuit-relay) - configuring Circuit Relay connections
5255
- [Connection Encryption](https://github.com/libp2p/js-libp2p-example-connection-encryption) - how to encrypt connection between libp2p nodes
5356
- [Delegated routing](https://github.com/libp2p/js-libp2p-example-delegated-routing) - how to offload network operations and queries onto more capable nodes
5457
- [Discovery mechanisms](https://github.com/libp2p/js-libp2p-example-discovery-mechanisms) - how libp2p discovers other peers on the network
5558
- [Custom protocols](https://github.com/libp2p/js-libp2p-example-custom-protocols) - how to create a custom protocol for your application
5659

57-
#### Other examples
60+
### Other examples
5861

5962
- [Chat](https://github.com/libp2p/js-libp2p-example-chat) - a simple chat app
6063
- [Browser Pub/Sub](https://github.com/libp2p/js-libp2p-example-browser-pubsub) - Using Pub/Sub between browsers
6164

62-
#### libp2p in the Browser
65+
### libp2p in browsers
6366

6467
There are a number of ways libp2p can be used in the browser. Here are some examples:
6568

66-
- [webRTC](./libp2p-in-the-browser/webrtc/README.md)
67-
- [websockets](./libp2p-in-the-browser/websockets/README.md)
68-
- [webtransport](./libp2p-in-the-browser/webtransport/README.md)
69+
- [webRTC](https://github.com/libp2p/js-libp2p-example-webrtc-private-to-private)
70+
- websockets (example pending)
71+
- webtransport (example pending)
6972

70-
There is also an tutorial of how all of these transports can be [universally connected](https://github.com/libp2p/universal-connectivity/tree/main)
71-
72-
### Prerequisites
73-
74-
Make sure you have installed all of the following prerequisites on your development machine:
75-
76-
- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
77-
- Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
73+
There is also [universal connectivity](https://github.com/libp2p/universal-connectivity/tree/main) demo that shows of how many different libp2p implementations can be connected together.
7874

7975
## Documentation
8076

81-
- [js-libp2p docs](https://github.com/libp2p/js-libp2p/tree/master/doc)
77+
- [js-libp2p docs](https://github.com/libp2p/js-libp2p/tree/main/doc)
8278
- [libp2p.io](https://libp2p.io)
8379
- [docs.libp2p.io](https://docs.libp2p.io)
84-
- [Specification (WIP)](https://github.com/libp2p/specs)
85-
- [Discussion Forums](https://discuss.libp2p.io)
80+
- [Specifications](https://github.com/libp2p/specs)
81+
- [Discussion Forums](https://github.com/libp2p/js-libp2p/discussions)
8682
- Talks
8783
- [`libp2p <3 ethereum` at DEVCON2](https://archive.devcon.org/archive/watch/2/libp2p-devp2p-ipfs-and-ethereum-networking/)
8884
- Articles
8985
- [The overview of libp2p](https://github.com/libp2p/libp2p#description)
9086

9187
## Contribute
9288

93-
See [CONTRIBUTING.md](./CONTRIBUTING.md).
89+
See [CONTRIBUTING.md](https://github.com/libp2p/js-libp2p-examples/blob/main/CONTRIBUTING.md).
9490

9591
## License
9692

9793
Licensed under either of
9894

99-
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
100-
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
95+
- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p-examples/blob/main/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
96+
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p-examples/blob/main/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

0 commit comments

Comments
 (0)