Skip to content

Commit

Permalink
docs: move section to GETTING_STARTED
Browse files Browse the repository at this point in the history
  • Loading branch information
maschad committed May 14, 2024
1 parent 71592d0 commit 76e8df0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
5 changes: 0 additions & 5 deletions doc/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
- [Configuring protocol name](#configuring-protocol-name)
- [Configuration examples](#configuration-examples)
- [Limits](#limits)
- [React Native](#react-native)

## Overview

Expand Down Expand Up @@ -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
5 changes: 5 additions & 0 deletions doc/GETTING_STARTED.md
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

0 comments on commit 76e8df0

Please sign in to comment.