docs: update React Native instructions in config (#2540)

Update React Native instructions in config Closes #2136
libp2p · May 16, 2024 · 5b73802 · 5b73802
1 parent 7de56f2
commit 5b73802
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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!