talksik/nearby_service
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: update readme and pubspec.yam

Browse Source
This commit is contained in:
ksenia312
2024-02-07 20:45:07 +01:00
parent f83c01a9b8
commit f36584bb09
2 changed files with 6 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -14
View File
@@ -67,15 +67,6 @@ the `nearby_service` plugin to open the settings and prompt the user to turn Wi-
All necessary Android permissions are already in the **AndroidManifest.xml** of the plugin, All necessary Android permissions are already in the **AndroidManifest.xml** of the plugin,
so you don't need to add anything **to work with p2p network**. so you don't need to add anything **to work with p2p network**.
> Note that if you want to use the plugin **to send files**, you need to add
> ```xml
> <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
> ```
> to your **AndroidManifest.xml**.
> If you are using an external package to work with the device's file system,
> follow that package's documentation about managing with permissions.
### IOS <a id="ios_setup"></a> ### IOS <a id="ios_setup"></a>
For IOS, you need to add the following values to **Info.plist**: For IOS, you need to add the following values to **Info.plist**:
@@ -109,8 +100,8 @@ For IOS, you need to add the following values to **Info.plist**:
This key is needed to inform users why your application will use the local network. You must provide a string value This key is needed to inform users why your application will use the local network. You must provide a string value
that explains why your application needs LAN access. that explains why your application needs LAN access.
> Note that if you want to use the plugin **to send files**, you also need to follow the instructions of the filesystem > Note that if you want to use the plugin **to send files**, you also need to follow the instructions about permissions
> management package you are using. > of the filesystem management package you are using.
## Usage ## Usage
@@ -291,7 +282,7 @@ one of 4 types:
We will talk more about them later. We will talk more about them later.
Second, there is another type of message, `ReceivedNearbyMessage`. This is what came to you from Second, there is another type of message, `ReceivedNearbyMessage`. This is what comes to you from
the `NearbyServiceMessagesListener`. It contains a `sender` field so that you can identify who the message came from and the `NearbyServiceMessagesListener`. It contains a `sender` field so that you can identify who the message came from and
use that information. use that information.
@@ -416,8 +407,8 @@ final messagesListener = NearbyServiceMessagesListener(
At this time under the hood, the sending of files will begin and the recipient will receive `ReceivedNearbyFilesPack` in At this time under the hood, the sending of files will begin and the recipient will receive `ReceivedNearbyFilesPack` in
the `NearbyServiceFilesListener` when sending is complete. `ReceivedNearbyFilesPack` holds the paths of the received the `NearbyServiceFilesListener` when sending is complete. `ReceivedNearbyFilesPack` holds the paths of the received
files already stored in the device. You can overwrite them to the desired location, delete them, or do anything else you files already stored on the device's temporary directory. You can overwrite them to the desired location, delete them,
like. or do anything else you like.
```dart ```dart
// DEVICE B // DEVICE B
pubspec.yaml
+1 -1
View File
@@ -1,5 +1,5 @@
name: nearby_service name: nearby_service
description: Nearby Service Flutter Plugin is used to create connections in a P2P network. With this plugin you can easily create any kind of information sharing application without Internet connection. description: Nearby Service Flutter Plugin is used to create connections in a P2P network. Supports sending text messages and files.
version: 0.0.1 version: 0.0.1
homepage: https://github.com/ksenia312/nearby_service homepage: https://github.com/ksenia312/nearby_service
repository: https://github.com/ksenia312/nearby_service repository: https://github.com/ksenia312/nearby_service