release: 0.0.5

This commit is contained in:
ksenia312
2024-02-09 12:22:12 +01:00
parent 00ed52fedc
commit 26ea985594
3 changed files with 31 additions and 3 deletions
+4
View File
@@ -1,3 +1,7 @@
## 0.0.5
- Update README: add Features section
## 0.0.4
- Update README: fix table of contents
+26 -2
View File
@@ -16,6 +16,7 @@ you can easily create any kind of information sharing application **without Inte
- [About](#about)
- [Android](#about-android-plugin)
- [IOS](#about-ios-plugin)
- [Features](#features)
- [Setup](#setup)
- [Android](#android-setup)
- [IOS](#ios-setup)
@@ -23,7 +24,7 @@ you can easily create any kind of information sharing application **without Inte
- [Data sharing](#data-sharing)
- [Text messages](#text-messages)
- [Resource messages](#resource-messages)
- [Additional features](#additional-features)
- [Additional options](#additional-options)
- [Demo](#demo)
## About
@@ -61,6 +62,29 @@ if both devices are on the same network, or using **peer-to-peer Wi-Fi** or **Bl
The module will work even with Wi-fi turned off (via Bluetooth), but you can still use `openServicesSettings()` from
the `nearby_service` plugin to open the settings and prompt the user to turn Wi-fi on.
## Features
- **Device Preparation**
- Requesting permissions to use Wi-Fi Direct (Android only)
- Checking Wi-Fi status (Android only)
- Opening settings to enable Wi-Fi (Android and iOS)
- Role selection - Browser or Advertiser (IOS only)
- **Connecting to the Device from a P2P Network**
- Listening for discovered devices (peers)
- Creating connections over the P2P network
- Monitoring the status of the connected device
- **The Data Transmission Channel**
- Establishing the channel for data exchange
- Monitoring the status of the channel
- **Typed Data Exchange**
- Transmitting text data over the P2P network
- Receiving confirmation of successful text message delivery
- Transmitting files over the P2P network
- The option to confirm or deny receiving of files over the network
## Setup
### Android setup
@@ -420,7 +444,7 @@ final filesListener = NearbyServiceFilesListener(
);
```
## Additional features
## Additional options
- Each `NearbyDevice` contains `NearbyDeviceInfo` that presents different meanings depending on the platform. For
Android `id` is the MAC address of the device, and for iOS it is the unique identifier of its MCPeerID. In general, id
+1 -1
View File
@@ -1,6 +1,6 @@
name: nearby_service
description: Nearby Service Flutter Plugin is used to create connections in a P2P network. Supports sending text messages and files.
version: 0.0.4
version: 0.0.5
homepage: https://github.com/ksenia312/nearby_service
repository: https://github.com/ksenia312/nearby_service