From ece251b699a2c567088a742825d9843a04a2c78d Mon Sep 17 00:00:00 2001 From: chad Date: Fri, 10 May 2024 21:28:27 -0500 Subject: [PATCH 1/2] docs: update React Native instructions in config (#2136) --- doc/CONFIGURATION.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/CONFIGURATION.md b/doc/CONFIGURATION.md index 2d923fe2e2..6d837926a6 100644 --- a/doc/CONFIGURATION.md +++ b/doc/CONFIGURATION.md @@ -37,6 +37,7 @@ - [Configuring protocol name](#configuring-protocol-name) - [Configuration examples](#configuration-examples) - [Limits](#limits) +- [React Native](#react-native) ## Overview @@ -1022,3 +1023,7 @@ The [examples repo](https://github.com/libp2p/js-libp2p-examples) is also a good ## Limits Configuring the various limits of your node is important to protect it when it is part of hostile of adversarial networks. See [LIMITS.md](https://github.com/libp2p/js-libp2p/tree/main/doc/LIMITS.md) for a full breakdown of the various built in protections and safeguards. + +## React Native + +Libp2p can be used in React Native applications. However, there are some limitations and considerations to take into account as not all transports are supported and some of the underlying dependencies may not work as expected. There is on-going work to address these issues, particularly around the support of TCP. For a demo on how to use libp2p in a React Native application, see https://github.com/ipfs-shipyard/js-libp2p-react-native \ No newline at end of file From 76e8df0a88323bc3b05887194756dbe92bf7a88a Mon Sep 17 00:00:00 2001 From: chad Date: Tue, 14 May 2024 15:18:20 -0500 Subject: [PATCH 2/2] docs: move section to GETTING_STARTED --- doc/CONFIGURATION.md | 5 ----- doc/GETTING_STARTED.md | 5 +++++ 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/CONFIGURATION.md b/doc/CONFIGURATION.md index 6d837926a6..2d923fe2e2 100644 --- a/doc/CONFIGURATION.md +++ b/doc/CONFIGURATION.md @@ -37,7 +37,6 @@ - [Configuring protocol name](#configuring-protocol-name) - [Configuration examples](#configuration-examples) - [Limits](#limits) -- [React Native](#react-native) ## Overview @@ -1023,7 +1022,3 @@ The [examples repo](https://github.com/libp2p/js-libp2p-examples) is also a good ## Limits Configuring the various limits of your node is important to protect it when it is part of hostile of adversarial networks. See [LIMITS.md](https://github.com/libp2p/js-libp2p/tree/main/doc/LIMITS.md) for a full breakdown of the various built in protections and safeguards. - -## React Native - -Libp2p can be used in React Native applications. However, there are some limitations and considerations to take into account as not all transports are supported and some of the underlying dependencies may not work as expected. There is on-going work to address these issues, particularly around the support of TCP. For a demo on how to use libp2p in a React Native application, see https://github.com/ipfs-shipyard/js-libp2p-react-native \ No newline at end of file diff --git a/doc/GETTING_STARTED.md b/doc/GETTING_STARTED.md index fa6d15ecf5..76645520bf 100644 --- a/doc/GETTING_STARTED.md +++ b/doc/GETTING_STARTED.md @@ -16,6 +16,7 @@ Welcome to libp2p! This guide will walk you through setting up a fully functiona - [Debugging](#debugging) - [Node](#node) - [Browser](#browser) + - [React Native](#react-native) - [What is next](#what-is-next) ## Install @@ -271,6 +272,10 @@ localStorage.setItem('debug', 'libp2p:*') // then refresh the page to ensure the localStorage.setItem('debug', 'libp2p:websockets,libp2p:webtransport,libp2p:kad-dht,libp2p:dialer') ``` +## React Native + +Libp2p can be used in React Native applications. However, there are some limitations and considerations to take into account as not all transports are supported and some of the underlying dependencies may not work as expected. There is on-going work to address these issues, particularly around the support of TCP. For a demo on how to use libp2p in a React Native application, see https://github.com/ipfs-shipyard/js-libp2p-react-native + ## What is next There are a lot of other concepts within `libp2p`, that are not covered in this guide. For additional configuration options we recommend checking out the [Configuration Readme](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md) and the [examples repo](https://github.com/libp2p/js-libp2p-examples). If you have any problems getting started, or if anything isn't clear, please let us know by submitting an issue!