Skip to content

mingder78/p2pworld

Repository files navigation

🌐 p2pworld

Welcome to p2pworld — a modern, modular, and developer-friendly peer-to-peer (P2P) networking library for TypeScript.


🚀 Features

  • TypeScript-first: Written in and for TypeScript, with full type safety.
  • Modular Design: Easily extend and customize core functionality.
  • Peer Discovery: Efficient peer finding and connection management.
  • Secure Communication: Built-in support for encrypted channels.
  • Extensive Documentation: Auto-generated with TypeDoc.

📦 Installation

npm install p2pworld

🛠️ Usage Example

import { P2PNode } from 'p2pworld';

const node = new P2PNode({ port: 9000 });

node.on('peer:connect', (peer) => {
  console.log('Connected to peer:', peer.id);
});

node.start();

📚 Documentation


🧑‍💻 Development

Clone the repo and install dependencies:

git clone https://github.com/YOUR_GITHUB_USERNAME/p2pworld.git
cd p2pworld
npm install

Generate documentation:

npm run docs

Run tests:

npm test

🤝 Contributing

Contributions are welcome! Please open issues and pull requests.


📄 License

MIT


⭐️ Show Your Support

If you like this project, please star the repo and share it with others!


About

create a playground for libp2p on both cli and browser

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published