Skip to content

Commit 754fe84

Browse files
authored
docs: update interface-internal readme (#2972)
Update the readme with the new package documentation block.
1 parent a2c529a commit 754fe84

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

packages/interface-internal/README.md

+23
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,29 @@
77

88
> Interfaces implemented by internal libp2p components
99
10+
# About
11+
12+
<!--
13+
14+
!IMPORTANT!
15+
16+
Everything in this README between "# About" and "# Install" is automatically
17+
generated and will be overwritten the next time the doc generator is run.
18+
19+
To make changes to this section, please update the @packageDocumentation section
20+
of src/index.js or src/index.ts
21+
22+
To experiment with formatting, please run "npm run docs" from the root of this
23+
repo and examine the changes made.
24+
25+
-->
26+
27+
This module serves as the entry point for `@libp2p/interface-internal`,
28+
exporting key components such as `AddressManager`, `ConnectionManager`,
29+
`RandomWalk`, `Registrar`, and `TransportManager`.
30+
31+
These interfaces and classes define the core internal behaviors of libp2p.
32+
1033
# Install
1134

1235
```console

packages/interface-internal/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* @packageDocumentation
33
*
44
* This module serves as the entry point for `@libp2p/interface-internal`,
5-
* re-exporting key components such as `AddressManager`, `ConnectionManager`,
5+
* exporting key components such as `AddressManager`, `ConnectionManager`,
66
* `RandomWalk`, `Registrar`, and `TransportManager`.
77
*
88
* These interfaces and classes define the core internal behaviors of libp2p.

0 commit comments

Comments
 (0)