Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
josxha committed Jun 10, 2024
1 parent 5062ccf commit 998771e
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 20 deletions.
2 changes: 2 additions & 0 deletions example/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
42 changes: 22 additions & 20 deletions maplibre_gl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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

Expand Down
2 changes: 2 additions & 0 deletions maplibre_gl/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions maplibre_gl_platform_interface/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions maplibre_gl_web/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 2 additions & 0 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 998771e

Please sign in to comment.