Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
achingbrain committed Mar 28, 2022
1 parent f18b2a4 commit 5f929a0
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
# JS libp2p Interfaces
# js-libp2p-daemon

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
[![](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-interfaces.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-interfaces)
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/ci?label=ci&style=flat-square)](https://github.com/libp2p/js-libp2p-interfaces/actions?query=branch%3Amaster+workflow%3Aci+)
[![test & maybe release](https://github.com/libp2p/js-libp2p-daemon/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/libp2p/js-libp2p-daemon/actions/workflows/js-test-and-release.yml)

> Contains test suites and interfaces you can use to implement the various components of libp2p
> Standalone libp2p executable
## Structure

* [`/packages/libp2p-connection`](./packages/libp2p-connection) An implementation of the Connection interface
* [`/packages/libp2p-interfaces`](./packages/libp2p-interfaces) The interface definitions of various libp2p components
* [`/packages/libp2p-interfaces-compliance-tests`](./packages/libp2p-interfaces-compliance-tests) Tests to ensure adherence of an implementation to the spec
* [`/packages/libp2p-pubsub`](./packages/libp2p-pubsub) An implementation of the Pubsub interface
* [`/packages/libp2p-topology`](./packages/libp2p-topology) An implementation of the Topology interface
* [`/packages/libp2p-daemon`](./packages/libp2p-daemon) The CLI tool - starts an instance of the server
* [`/packages/libp2p-daemon-client`](./packages/libp2p-daemon-client) A client to talk to libp2p-daemon instances
* [`/packages/libp2p-daemon-protocol`](./packages/libp2p-daemon-protocol) The wire protocol used by the client/server
* [`/packages/libp2p-daemon-server`](./packages/libp2p-daemon-server) An RPC server controllable by the client

## Contribute

Expand Down

0 comments on commit 5f929a0

Please sign in to comment.