Skip to content

Commit

Permalink
Updated CHANGELOG.md and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nimrodda committed Mar 13, 2021
1 parent 7a5e0cc commit a82d5c7
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 22 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 1.0.0

* Changed version scheme to adhere to pub version guidelines (dropping the 'alpha')
* Updated README.md with detailed instructions on support for iOS 14
* Removed Flutter version bounds so that the plugin can be used with Flutter 2+

## 1.0.0-alpha03

* Increased Dart SDK to 2.12.0-0
Expand Down
47 changes: 25 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,9 @@
# Flutter Network Service Discovery plugin

This Flutter plugin provides Network Service Discovery (NSD) API on iOS and Android
Flutter plugin that provides Network Service Discovery (NSD) API on iOS and Android
for discovering services that other devices provide on a local network.

The plugin is currently under development and right now only supports discovery,
but not registry of services.

## Note about Android

Android emulator doesn't support Network Service Discovery so you'll have to use a real device.

## Note about iOS

To support legacy iOS devices, `NetServiceBrowser` is used, which means that you will need
to apply for entitlement from Apple for Local Network Access. Also, you'll have to
make some modifications to your Info.plist file. For more info visit:
https://developer.apple.com/videos/play/wwdc2020/10110/

*You don't need to worry about this if you are just testing with a simulator.*

## iOS Help needed!

I'm an Android developer, so it might be that the iOS implementation isn't great.
I'd really appreciate help from an iOS developer, who's willing to review the code and improve it.
The plugin is currently only supports discovery, but not registry of services.

## Getting Started

Expand Down Expand Up @@ -64,9 +45,31 @@ void stopDiscoveryButton() async {

See the example project for a more detailed Flutter app example.

## Note about Android

Minimum Android API version supported is 21.

Android emulator doesn't support Network Service Discovery so you'll have to use a real device.

## Note about iOS

This plugin uses `NetServiceBrowser` and can therefore support iOS version 9+.

On iOS 14+, you need to modify Info.plist file and add two keys:
`Bonjour Services` - this is an array, the first item should be the service you're trying to
discover. For example, `_example._tcp.`.
`Privacy - Local Network Usage Description` - this key is for granting the app local network access.
The value is the text which will be shown to the user in a permission dialog once you call
`flutterNsd.discoverServices()`.

For more info about network discovery on iOS 14, I suggest you watch this video:
https://developer.apple.com/videos/play/wwdc2020/10110/

*Note that you don't need to worry about modifying Info.plist if you are just testing with a simulator.*

## License

Copyright 2020 Nimrod Dayan nimroddayan.com
Copyright 2021 Nimrod Dayan nimroddayan.com

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit a82d5c7

Please sign in to comment.