Skip to content

Commit

Permalink
Updated readme and pubspec
Browse files Browse the repository at this point in the history
  • Loading branch information
Nimrodda committed Feb 7, 2022
1 parent 70ba381 commit 2ea3cc6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

# Flutter Network Service Discovery plugin

Flutter plugin that provides Network Service Discovery (NSD) API on iOS, Android, MacOS and Windows
for discovering services that other devices provide on a local network.
A Flutter plugin for Network Service Discovery (mDNS) on Android, iOS, MacOS and Windows. The plugin uses the platform's own API when possible.

The plugin currently only supports discovery, but not registry of services.

Expand Down Expand Up @@ -102,21 +101,21 @@ The current implementation will send MDNS multicast every 10 seconds until stopp

Due to the native socket calls, any app using this plugin on windows will trigger a dialog from Windows to allow network access on the first launch.

For Windows development you will need Visual Studio 2019 with the C++ workload installed, see https://docs.flutter.dev/desktop#additional-windows-requirements
For Windows development you will need Visual Studio 2019 or higher with the C++ workload installed, see https://docs.flutter.dev/desktop#additional-windows-requirements

## Testing

On MacOS it's easy to test network service discovery via the following command which will create a mock service:

```
dns-sd -R MyJsonServer1 _http._tcp . 3000 foo=bar
dns-sd -R TestService _http._tcp . 3000
```

Then scan for this service using the example app on any of the supported platforms.

## License

Copyright 2021 Nimrod Dayan nimroddayan.com
Copyright 2022 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
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: flutter_nsd
description: A Flutter plugin that enables Network Service Discovery on various platforms via their native APIs.
description: A Flutter plugin for Network Service Discovery (mDNS) on Android, iOS, MacOS and Windows. The plugin uses the platform's own API when possible. Supports discovery only, no registry.
version: 1.3.0
homepage: https://github.com/Nimrodda/flutter_nsd

Expand Down

0 comments on commit 2ea3cc6

Please sign in to comment.