mirror of
https://github.com/status-im/nim-libp2p.git
synced 2025-01-12 05:54:51 +00:00
a4090c7382
* update readme and organize the example folder * adding package list * add packages done * basic readme done * fix the go-daemon example folder * add go-daemon folder in readme * fix readme icon * add badges * add nim min version * Update README background Co-Authored-By: Dmitriy Ryajov <dryajov@gmail.com> * fix all the comments * Update README.md wording Co-Authored-By: Dmitriy Ryajov <dryajov@gmail.com> * fix file path in examples/ * add comments to example * add comments to directchat and fix start.nim * remove unnecessary modules from directchat * del customdata * improve directchat * finish second.nim * removea gcsafe * with err * change var to let * remove final.nim * fix comments on pull request * fix comments on pull request * replace result with return * add hint when start and exit command * update output string * fix above comments * add api documentation * fix readme format * update readme format * readme table of content done * fix format * fix format * include links to the tutorial article Co-authored-by: Dmitriy Ryajov <dryajov@gmail.com>
29 lines
1022 B
Markdown
29 lines
1022 B
Markdown
# Introduction
|
|
This folder contains the documentation for each nim-libp2p module and the sample code for the tutorials.
|
|
|
|
# Table of Contents
|
|
### [Getting Started](GETTING_STARTED.md)
|
|
### Tutorials
|
|
- P2P Chat Example
|
|
- [part I](tutorial/directchat/start.nim)
|
|
- [part II](tutorial/directchat/second.nim)
|
|
### API Specifications
|
|
- libp2p
|
|
- [libp2p-daemon-client](api/libp2p/daemonapi.md)
|
|
- [interop-libp2p](api/libp2p/interop.md)
|
|
- transports
|
|
- [libp2p-tcp](api/transports/tcptransport.md)
|
|
- secure channels
|
|
- [libp2p-secio](api/secure_channels/secio.md)
|
|
- stream multiplexers
|
|
- [libp2p-mplex](api/stream_multiplexers/mplex.md)
|
|
- utilities
|
|
- [libp2p-crypto](api/utilities/crypto.md)
|
|
- [libp2p-crypto-secp256k1](api/utilities/secp256k1.md)
|
|
- data types
|
|
- [peer-id](api/data_types/peer.md)
|
|
- [peer-info](api/data_types/peerinfo.md)
|
|
- pubsub
|
|
- [libp2p-pubsub](api/pubsub/pubsub.md)
|
|
- [libp2p-floodsub](api/pubsub/floodsub.md)
|
|
- [libp2p-gossipsub](api/pubsub/gossipsub.md) |