Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update React Native instructions in config #2540

Merged
merged 4 commits into from
May 16, 2024
Merged

docs: update React Native instructions in config #2540

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ece251b
docs: update React Native instructions in config (#2136)
maschad May 11, 2024
d6bcd30
Merge branch 'main' into docs/update-readme-react-native
maschad May 14, 2024
71592d0
Merge branch 'main' into docs/update-readme-react-native
maschad May 14, 2024
76e8df0
docs: move section to GETTING_STARTED
maschad May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/GETTING_STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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!
Expand Down
Loading