Skip to content

Commit

Permalink
[multicast_dns] Adjust README (flutter#5529)
Browse files Browse the repository at this point in the history
- Improves link targets to be more directly useful.
- Removes the unnecessary code sections showing an import, since the install tab already demonstrates that.
- Removes the no-longer-needed exemption from the excerpt requirement.

Part of flutter/flutter#102679
  • Loading branch information
stuartmorgan committed Dec 9, 2023
1 parent 51174d1 commit cb6dbcd
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 12 deletions.
4 changes: 4 additions & 0 deletions packages/multicast_dns/CHANGELOG.md
@@ -1,3 +1,7 @@
## 0.3.2+6

* Improves links in README.md.

## 0.3.2+5

* Updates `PendingRequest` to be a `base class` for Dart 3.0 compatibility.
Expand Down
14 changes: 4 additions & 10 deletions packages/multicast_dns/README.md
Expand Up @@ -6,15 +6,9 @@ https://pub.dartlang.org/packages/multicast_dns)
A Dart package to do service discovery over multicast DNS (mDNS), Bonjour, and Avahi.

## Usage
To use this package, add `multicast_dns` as a
[dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).

## Example

Import the library via
``` dart
import 'package:multicast_dns/multicast_dns.dart';
```
To use this package, add `multicast_dns` as a
[dependency in your pubspec.yaml file](https://pub.dev/packages/multicast_dns/install).

Then use the `MDnsClient` Dart class in your code. To see how this is done,
check out the [example app](example/main.dart).
[The example](https://pub.dev/packages/multicast_dns/example) demonstrates how
to use the `MDnsClient` Dart class in your code.
2 changes: 1 addition & 1 deletion packages/multicast_dns/pubspec.yaml
Expand Up @@ -2,7 +2,7 @@ name: multicast_dns
description: Dart package for performing mDNS queries (e.g. Bonjour, Avahi).
repository: https://github.com/flutter/packages/tree/main/packages/multicast_dns
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+multicast_dns%22
version: 0.3.2+5
version: 0.3.2+6

environment:
sdk: ">=3.0.0 <4.0.0"
Expand Down
1 change: 0 additions & 1 deletion script/configs/temp_exclude_excerpt.yaml
Expand Up @@ -13,7 +13,6 @@
- image_picker_for_web
- in_app_purchase/in_app_purchase
- ios_platform_images
- multicast_dns
- palette_generator
- pointer_interceptor
- quick_actions/quick_actions

0 comments on commit cb6dbcd

Please sign in to comment.