Skip to content

Commit b391abd

Browse files
committed
docs: update readme
1 parent 126411b commit b391abd

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,26 @@
1616
<a href="https://github.com/libp2p/js-libp2p-examples/issues">Request Feature/Example</a>
1717
</p>
1818

19-
## Table of Contents
19+
## Table of Contents <!-- omit in toc -->
2020

2121
- [About The Project](#about-the-project)
2222
- [Getting Started](#getting-started)
2323
- [Prerequisites](#prerequisites)
2424
- [Understanding how libp2p works](#understanding-how-libp2p-works)
2525
- [Other examples](#other-examples)
26-
- [libp2p in browsers](#libp2p-in-browsers)
2726
- [Documentation](#documentation)
2827
- [Contribute](#contribute)
2928
- [License](#license)
3029

3130
## About The Project
3231

33-
- Read the [docs](https://ipfs.github.io/helia/modules/helia.html)
34-
- Look into other [examples](https://github.com/libp2p/js-libp2p-examples) to learn how to spawn a Helia node in Node.js and in the Browser
32+
- Read the [js-libp2p documentation](https://github.com/libp2p/js-libp2p/tree/main/doc)
33+
- Check out the [js-libp2p API docs](https://libp2p.github.io/js-libp2p/)
3534
- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it
3635
- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs
3736
- Check out https://docs.ipfs.io for tips, how-tos and more
38-
- See https://blog.ipfs.io for news and more
39-
- Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io
37+
- See https://blog.libp2p.io for news and more
38+
- Need help? Please ask 'How do I?' questions on https://github.com/libp2p/js-libp2p/discussions
4039

4140
## Getting Started
4241

@@ -56,20 +55,16 @@ Make sure you have installed all of the following prerequisites on your developm
5655
- [Delegated routing](https://github.com/libp2p/js-libp2p-example-delegated-routing) - how to offload network operations and queries onto more capable nodes
5756
- [Discovery mechanisms](https://github.com/libp2p/js-libp2p-example-discovery-mechanisms) - how libp2p discovers other peers on the network
5857
- [Custom protocols](https://github.com/libp2p/js-libp2p-example-custom-protocols) - how to create a custom protocol for your application
58+
- [Transports](https://github.com/libp2p/js-libp2p-example-transports) - how to connect peers together via different transports
59+
- [WebRTC](https://github.com/libp2p/js-libp2p-example-webrtc-private-to-private) - a special transport for connecting browsers together
5960

6061
### Other examples
6162

63+
These are demo apps or examples that showcase specific modules or services:
64+
6265
- [Chat](https://github.com/libp2p/js-libp2p-example-chat) - a simple chat app
6366
- [Browser Pub/Sub](https://github.com/libp2p/js-libp2p-example-browser-pubsub) - Using Pub/Sub between browsers
6467

65-
### libp2p in browsers
66-
67-
There are a number of ways libp2p can be used in the browser. Here are some examples:
68-
69-
- [webRTC](https://github.com/libp2p/js-libp2p-example-webrtc-private-to-private)
70-
- websockets (example pending)
71-
- webtransport (example pending)
72-
7368
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.
7469

7570
## Documentation

0 commit comments

Comments
 (0)