Skip to content

Commit

Permalink
fix broken links in location_platform_interface README
Browse files Browse the repository at this point in the history
  • Loading branch information
bartekpacia committed Aug 4, 2023
1 parent 16aab9d commit 91ebae4
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions packages/location_platform_interface/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# location_platform_interface

A common platform interface for the [`location`][1] plugin.
A common platform interface for the [`location`][location] plugin.

This interface allows platform-specific implementations of the `location`
plugin, as well as the plugin itself, to ensure they are supporting the
same interface.
plugin, as well as the plugin itself, to ensure they are supporting the same
interface.

# Usage

To implement a new platform-specific implementation of `location`, extend
[`LocationPlatform`][2] with an implementation that performs the
[`LocationPlatform`][LocationPlatform] with an implementation that performs the
platform-specific behavior, and when you register your plugin, set the default
`LocationPlatform` by calling
`LocationPlatform.instance = MyLocation()`.
`LocationPlatform` by calling `LocationPlatform.instance = MyLocation()`.

# Note on breaking changes

Expand All @@ -22,5 +21,5 @@ over breaking changes for this package.
See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
on why a less-clean interface is preferable to a breaking change.

[1]: ../location
[2]: lib/location_platform_interface.dart
[location]: https://pub.dev/packages/location
[LocationPlatform]: https://github.com/Lyokone/flutterlocation/blob/master/packages/location_platform_interface/lib/location_platform_interface.dart

0 comments on commit 91ebae4

Please sign in to comment.