@libp2p/circuit-relay-v2 0.0.0-97ab31c0c

package/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,69 @@
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
+[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amaster)
+
+> Implementation of Circuit Relay v2
+
+# About
+
+The `circuitRelayTransport` allows libp2p to dial and listen on [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
+addresses.
+
+## Example
+
+```typescript
+import { createLibp2p } from 'libp2p'
+import { circuitRelayTransport } from '@libp2p/circuit-relay-v2'
+
+const node = await createLibp2p({
+  transports: [
+    circuitRelayTransport()
+  ]
+})
+```
+
+The `circuitRelayServer` function allows libp2p to function as a [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
+server.  This will not work in browsers.
+
+## Example
+
+```typescript
+import { createLibp2p } from 'libp2p'
+import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
+
+const node = await createLibp2p({
+  services: [
+    circuitRelay: circuitRelayServer()
+  ]
+})
+```
+
+# Install
+
+```console
+$ npm i @libp2p/circuit-relay-v2
+```
+
+## Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pCircuitRelayV2` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/circuit-relay-v2/dist/index.min.js"></script>
+```
+
+# API Docs
+
+- <https://libp2p.github.io/js-libp2p/modules/_libp2p_circuit_relay_v2.html>
+
+# License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+# Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.