This repo contains readable documentation about various tools, features, and concepts in Libp2p. In the future, we hope to turn it into an actual documentation website that collects documentation and information from across all the Libp2p projects and repos.
We’d like to include several kinds of content here, including:
-
Introductory overview. A clear, understandable introduction to Libp2p’s overall ideas and usage.
-
Concepts. Libp2p includes a lot of new concepts around addressing, networking, and data sharing. Concept docs provide a high-level overview of these.
-
Guides, examples, and tutorials. Most examples currently live in other repos. If you have thoughts on how to better integrate them, please file an issue here!
If you’d like to write some of these docs, we’d absolutely love your help! ❤️ Please post an issue describing what you plan to document and a general overview or outline so folks know what you’re working on, and once you have decent draft, submit a PR!
All software code is copyright (c) Protocol Labs, Inc. under the MIT license.
Other written documentation and content copyright (c) Protocol Labs, Inc. under the Creative Commons Attribution-Share-Alike License.
See LICENSE file for details.