diff --git a/example/pubspec.yaml b/example/pubspec.yaml index 343c6178..2cb4127f 100644 --- a/example/pubspec.yaml +++ b/example/pubspec.yaml @@ -2,6 +2,8 @@ name: maplibre_gl_example description: Demonstrates how to use the maplibre_gl plugin. publish_to: 'none' version: 1.0.0+1 +homepage: https://maplibre.org/flutter-maplibre-gl +documentation: https://maplibre.org/flutter-maplibre-gl/docs repository: https://github.com/maplibre/flutter-maplibre-gl issue_tracker: https://github.com/maplibre/flutter-maplibre-gl/issues diff --git a/maplibre_gl/README.md b/maplibre_gl/README.md index 795aa862..abed33a7 100644 --- a/maplibre_gl/README.md +++ b/maplibre_gl/README.md @@ -5,24 +5,29 @@ [![Pub Points](https://img.shields.io/pub/points/maplibre_gl)](https://pub.dev/packages/maplibre_gl/score) [![stars](https://badgen.net/github/stars/maplibre/flutter-maplibre-gl?label=stars&color=green&icon=github)](https://github.com/josxha/flutter-maplibre-gl/stargazers) -This Flutter plugin allows to show **embedded interactive and customizable -vector maps** as a Flutter widget. +`maplibre_gl` provides bindings for native MapLibre libraries to use in a +Flutter application. It allows you to show performant interactive and +customizable vector maps as a Flutter widget. -- This project is a fork - of [flutter-mapbox-gl](https://github.com/tobrun/flutter-mapbox-gl), - replacing its usage of Mapbox GL libraries with the open - source [MapLibre GL](https://github.com/maplibre) libraries. +This project is a fork of +[flutter-mapbox-gl](https://github.com/tobrun/flutter-mapbox-gl), replacing its +usage of Mapbox GL libraries with the open source +[MapLibre GL](https://github.com/maplibre) libraries. ### Supported Platforms - Support for **web** through [maplibre-gl-js](https://github.com/maplibre/maplibre-gl-js) - Support for **android** and **iOS** through [maplibre-native](https://github.com/maplibre/maplibre-native) -This project only supports a subset of the API exposed by these libraries. +This project currently supports only a subset of the API exposed by these +libraries. ## Documentation -- Check +- Check out the + [Getting Started Guide](https://maplibre.org/flutter-maplibre-gl/docs/category/getting-started) +- Dive into the hosted [Documentation](https://maplibre.org/flutter-maplibre-gl/docs/) +- Explore the [API documentation](https://pub.dev/documentation/maplibre_gl/latest/). - See example implementations in our [example project](https://github.com/maplibre/flutter-maplibre-gl/tree/main/example). @@ -32,18 +37,15 @@ This project only supports a subset of the API exposed by these libraries. ## Getting Help -- **Need help?**: Check - the [GitHub Discussions](https://github.com/maplibre/flutter-maplibre-gl/discussions) - or open a new thread. - Or look for previous questions on - the [#maplibre](https://stackoverflow.com/questions/tagged/maplibre) - - tag - or [ask a new question](https://stackoverflow.com/questions/tagged/maplibre). -- **Have a bug to report?** - [Open an issue](https://github.com/maplibre/flutter-maplibre-gl/issues/new). - If possible, include a full log, code and information which shows the issue. -- **Have a feature request?** - [Open an issue](https://github.com/maplibre/flutter-maplibre-gl/issues/new). - Tell us what the feature should do and why you want the feature. +- **Need help?** + - Check the Q&A section in the + [GitHub Discussions](https://github.com/maplibre/flutter-maplibre-gl/discussions). + - Look on StackOverflow for previous questions on the + [#maplibre-gl](https://stackoverflow.com/questions/tagged/maplibre-gl) tag, or + [ask a new question](https://stackoverflow.com/questions/tagged/maplibre-gl). +- **Found a bug?** + - [Open an issue](https://github.com/maplibre/flutter-maplibre-gl/issues/new). + Please include a full log, code and information which shows the issue. ## Contributing diff --git a/maplibre_gl/pubspec.yaml b/maplibre_gl/pubspec.yaml index c1d1a063..2c238dfe 100644 --- a/maplibre_gl/pubspec.yaml +++ b/maplibre_gl/pubspec.yaml @@ -1,6 +1,8 @@ name: maplibre_gl description: A Flutter plugin for integrating MapLibre Maps inside a Flutter application on Android, iOS and web platforms. version: 0.20.0 +homepage: https://maplibre.org/flutter-maplibre-gl +documentation: https://maplibre.org/flutter-maplibre-gl/docs repository: https://github.com/maplibre/flutter-maplibre-gl issue_tracker: https://github.com/maplibre/flutter-maplibre-gl/issues diff --git a/maplibre_gl_platform_interface/pubspec.yaml b/maplibre_gl_platform_interface/pubspec.yaml index e2b3c444..2fdb9a22 100644 --- a/maplibre_gl_platform_interface/pubspec.yaml +++ b/maplibre_gl_platform_interface/pubspec.yaml @@ -1,6 +1,8 @@ name: maplibre_gl_platform_interface description: A common platform interface for the maplibre_gl plugin. This package is only intended to be used by the maplibre_gl package. version: 0.20.0 +homepage: https://maplibre.org/flutter-maplibre-gl +documentation: https://maplibre.org/flutter-maplibre-gl/docs repository: https://github.com/maplibre/flutter-maplibre-gl issue_tracker: https://github.com/maplibre/flutter-maplibre-gl/issues diff --git a/maplibre_gl_web/pubspec.yaml b/maplibre_gl_web/pubspec.yaml index 57a9b300..0e308dc7 100644 --- a/maplibre_gl_web/pubspec.yaml +++ b/maplibre_gl_web/pubspec.yaml @@ -1,6 +1,8 @@ name: maplibre_gl_web description: Web platform implementation of maplibre_gl. This package is only intended to be used by the maplibre_gl package. version: 0.20.0 +homepage: https://maplibre.org/flutter-maplibre-gl +documentation: https://maplibre.org/flutter-maplibre-gl/docs repository: https://github.com/maplibre/flutter-maplibre-gl issue_tracker: https://github.com/maplibre/flutter-maplibre-gl/issues diff --git a/pubspec.yaml b/pubspec.yaml index 874f73d3..113ef204 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,7 @@ name: maplibre_gl_workspace publish_to: 'none' +homepage: https://maplibre.org/flutter-maplibre-gl +documentation: https://maplibre.org/flutter-maplibre-gl/docs repository: https://github.com/maplibre/flutter-maplibre-gl issue_tracker: https://github.com/maplibre/flutter-maplibre-gl/issues