libp2p 2.7.5 → 2.8.0-600d0a561
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -1
- package/dist/index.min.js +9 -9
- package/dist/src/registrar.d.ts +2 -2
- package/dist/src/registrar.d.ts.map +1 -1
- package/dist/src/upgrader.d.ts +4 -2
- package/dist/src/upgrader.d.ts.map +1 -1
- package/dist/src/upgrader.js +9 -2
- package/dist/src/upgrader.js.map +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/src/version.d.ts.map +1 -1
- package/dist/src/version.js +1 -1
- package/dist/src/version.js.map +1 -1
- package/package.json +10 -10
- package/src/registrar.ts +2 -2
- package/src/upgrader.ts +14 -5
- package/src/version.ts +1 -1
- package/dist/typedoc-urls.json +0 -21
package/README.md
CHANGED
|
@@ -8,10 +8,39 @@
|
|
|
8
8
|
[](https://www.npmjs.com/package/libp2p)
|
|
9
9
|
[](https://discuss.libp2p.io)
|
|
10
10
|
[](http://webchat.freenode.net/?channels=%23libp2p)
|
|
11
|
-
[](https://discord.com/invite/Ae4TbahHaT)
|
|
12
12
|
[](https://codecov.io/gh/libp2p/js-libp2p)
|
|
13
13
|
[](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)
|
|
14
14
|
|
|
15
|
+
# About
|
|
16
|
+
|
|
17
|
+
<!--
|
|
18
|
+
|
|
19
|
+
!IMPORTANT!
|
|
20
|
+
|
|
21
|
+
Everything in this README between "# About" and "# Install" is automatically
|
|
22
|
+
generated and will be overwritten the next time the doc generator is run.
|
|
23
|
+
|
|
24
|
+
To make changes to this section, please update the @packageDocumentation section
|
|
25
|
+
of src/index.js or src/index.ts
|
|
26
|
+
|
|
27
|
+
To experiment with formatting, please run "npm run docs" from the root of this
|
|
28
|
+
repo and examine the changes made.
|
|
29
|
+
|
|
30
|
+
-->
|
|
31
|
+
|
|
32
|
+
Use the `createLibp2p` function to create a libp2p node.
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import { createLibp2p } from 'libp2p'
|
|
38
|
+
|
|
39
|
+
const node = await createLibp2p({
|
|
40
|
+
// ...other options
|
|
41
|
+
})
|
|
42
|
+
```
|
|
43
|
+
|
|
15
44
|
# Background
|
|
16
45
|
|
|
17
46
|
libp2p is the product of a long and arduous quest to understand the evolution of the Internet networking stack. In order to build P2P applications, devs have long had to make custom ad-hoc solutions to fit their needs, sometimes making some hard assumptions about their runtimes and the state of the network at the time of their development. Today, looking back more than 20 years, we see a clear pattern in the types of mechanisms built around the Internet Protocol, IP, which can be found throughout many layers of the OSI layer system, libp2p distils these mechanisms into flat categories and defines clear interfaces that once exposed, enable other protocols and applications to use and swap them, enabling upgradability and adaptability for the runtime, without breaking the API.
|