Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate links in README, pubspec to Maplibre #224

Merged
merged 1 commit into from
Apr 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

We welcome contributions to this repository. Please follow these steps if you're interested in making contributions:

1. Please familiarize yourself with the [process of running the example app](https://github.com/m0nac0/flutter-maplibre-gl#running-the-example-app).
2. Ensure that existing [pull requests](https://github.com/m0nac0/flutter-maplibre-gl/pulls) and [issues](https://github.com/m0nac0/flutter-maplibre-gl/issues) don’t already cover your contribution or question.
1. Please familiarize yourself with the [process of running the example app](https://github.com/maplibre/flutter-maplibre-gl#running-the-example-app).
2. Ensure that existing [pull requests](https://github.com/maplibre/flutter-maplibre-gl/pulls) and [issues](https://github.com/maplibre/flutter-maplibre-gl/issues) don’t already cover your contribution or question.

3. Create a new branch that will contain your contributed code. Along with your contribution you should also adapt the example app to showcase any new features or APIs you have developed. This also makes testing your contribution much easier. Eventually create a pull request once you're done making changes.

4. If there are any changes that developers should be aware of, please update the [changelog](https://github.com/m0nac0/flutter-maplibre-gl/blob/master/CHANGELOG.md) once your pull request has been merged to the `master` branch.
4. If there are any changes that developers should be aware of, please update the [changelog](https://github.com/maplibre/flutter-maplibre-gl/blob/master/CHANGELOG.md) once your pull request has been merged to the `master` branch.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Flutter Maplibre GL
[![Flutter CI](https://github.com/m0nac0/flutter-maplibre-gl/actions/workflows/flutter_ci.yml/badge.svg)](https://github.com/m0nac0/flutter-maplibre-gl/actions/workflows/flutter_ci.yml)
[![Generate docs](https://github.com/m0nac0/flutter-maplibre-gl/actions/workflows/generate_docs.yml/badge.svg)](https://github.com/m0nac0/flutter-maplibre-gl/actions/workflows/generate_docs.yml)
[![Flutter CI](https://github.com/maplibre/flutter-maplibre-gl/actions/workflows/flutter_ci.yml/badge.svg)](https://github.com/maplibre/flutter-maplibre-gl/actions/workflows/flutter_ci.yml)
[![Generate docs](https://github.com/maplibre/flutter-maplibre-gl/actions/workflows/generate_docs.yml/badge.svg)](https://github.com/maplibre/flutter-maplibre-gl/actions/workflows/generate_docs.yml)

> ``⚠️`` Current notice: the repository has been transferred to the @maplibre organization. You shouldn't see any negative effects, as GitHub automatically redirects references from the old URL to the new URL. Please see [#221](https://github.com/maplibre/flutter-maplibre-gl/issues/221) for more information.

Expand All @@ -24,11 +24,11 @@ dependencies:
...
maplibre_gl:
git:
url: https://github.com/m0nac0/flutter-maplibre-gl.git
url: https://github.com/maplibre/flutter-maplibre-gl.git
ref: main
```
This will get you the very latest changes from the main branch.
You can replace `main` with the name of the [latest release](https://github.com/m0nac0/flutter-maplibre-gl/releases)
You can replace `main` with the name of the [latest release](https://github.com/maplibre/flutter-maplibre-gl/releases)
to get a more stable version.


Expand All @@ -39,12 +39,12 @@ Compared to flutter-mapbox-gl, the only breaking API changes are:


### Documentation
Documentation is available on the docs branch in the doc/api folder and automatically updated on each push to the main branch. You can easily preview the [documentation / API reference here.](https://htmlpreview.github.io/?https://github.com/m0nac0/flutter-maplibre-gl/blob/docs/doc/api/index.html)
Documentation is available on the docs branch in the doc/api folder and automatically updated on each push to the main branch. You can easily preview the [documentation / API reference here.](https://htmlpreview.github.io/?https://github.com/maplibre/flutter-maplibre-gl/blob/docs/doc/api/index.html)

Please visit [https://github.com/maplibre/maplibre-gl-js](https://github.com/maplibre/maplibre-gl-js) and [https://github.com/maplibre/maplibre-gl-native](https://github.com/maplibre/maplibre-gl-native) for more information about the Maplibre libraries.

### iOS
To use this plugin with iOS, you need to add the source repository and 2 additional pods to your Podfile, as shown in the example app: https://github.com/m0nac0/flutter-maplibre-gl/blob/main/example/ios/Podfile
To use this plugin with iOS, you need to add the source repository and 2 additional pods to your Podfile, as shown in the example app: https://github.com/maplibre/flutter-maplibre-gl/blob/main/example/ios/Podfile

```ruby
source 'https://cdn.cocoapods.org/'
Expand Down Expand Up @@ -119,10 +119,10 @@ A possible explanation could be: "Shows your location on the map".

## Getting Help

- **Need help with your code?**: Check the [discussions](https://github.com/m0nac0/flutter-maplibre-gl/discussions) on this repo or open a new one.
- **Need help with your code?**: Check the [discussions](https://github.com/maplibre/flutter-maplibre-gl/discussions) on this repo or open a new one.
Or look for previous questions on the [#maplibre tag](https://stackoverflow.com/questions/tagged/maplibre) — or [ask a new question](https://stackoverflow.com/questions/tagged/maplibre).
- **Have a bug to report?** [Open an issue](https://github.com/m0nac0/flutter-maplibre-gl/issues/new). If possible, include a full log and information which shows the issue.
- **Have a feature request?** [Open an issue](https://github.com/m0nac0/flutter-maplibre-gl/issues/new). Tell us what the feature should do and why you want the feature.
- **Have a bug to report?** [Open an issue](https://github.com/maplibre/flutter-maplibre-gl/issues/new). If possible, include a full log 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.

## Running in GitHub Codespaces
When you open this project in GitHub Codespaces, you can run the example app on web with the command `flutter run -d web-server --web-hostname=0.0.0.0`
Expand Down Expand Up @@ -174,4 +174,4 @@ Note : iOS will display the error : `NSPredicate: Use of 'mgl_does:have:' as an
## Contributing


[Feedback](https://github.com/m0nac0/flutter-maplibre-gl/issues) and contributions are very welcome!
[Feedback](https://github.com/maplibre/flutter-maplibre-gl/issues) and contributions are very welcome!
2 changes: 1 addition & 1 deletion maplibre_gl_platform_interface/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Contains the web platform implementation for the [Flutter Maplibre GL plugin](https://github.com/m0nac0/flutter-maplibre-gl).
Contains the web platform implementation for the [Flutter Maplibre GL plugin](https://github.com/maplibre/flutter-maplibre-gl).
2 changes: 1 addition & 1 deletion maplibre_gl_platform_interface/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: maplibre_gl_platform_interface
description: A common platform interface for the maplibre_gl plugin.
version: 0.16.0
homepage: https://github.com/m0nac0/flutter-maplibre-gl
homepage: https://github.com/maplibre/flutter-maplibre-gl

dependencies:
flutter:
Expand Down
2 changes: 1 addition & 1 deletion maplibre_gl_web/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Contains the web interfaces for the [Flutter Maplibre GL plugin](https://github.com/m0nac0/flutter-maplibre-gl).
Contains the web interfaces for the [Flutter Maplibre GL plugin](https://github.com/maplibre/flutter-maplibre-gl).
4 changes: 2 additions & 2 deletions maplibre_gl_web/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: maplibre_gl_web
description: Web platform implementation of maplibre_gl
version: 0.16.0
homepage: https://github.com/m0nac0/flutter-maplibre-gl
homepage: https://github.com/maplibre/flutter-maplibre-gl

flutter:
plugin:
Expand All @@ -18,7 +18,7 @@ dependencies:
meta: ^1.3.0
maplibre_gl_platform_interface:
git:
url: https://github.com/m0nac0/flutter-maplibre-gl.git
url: https://github.com/maplibre/flutter-maplibre-gl.git
path: maplibre_gl_platform_interface
ref: main
maplibre_gl_dart:
Expand Down
6 changes: 3 additions & 3 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
name: maplibre_gl
description: A Flutter plugin for integrating Maplibre Maps inside a Flutter application on Android, iOS and web platforms.
version: 0.16.0
homepage: https://github.com/m0nac0/flutter-maplibre-gl
homepage: https://github.com/maplibre/flutter-maplibre-gl

dependencies:
flutter:
sdk: flutter
maplibre_gl_platform_interface:
git:
url: https://github.com/m0nac0/flutter-maplibre-gl.git
url: https://github.com/maplibre/flutter-maplibre-gl.git
path: maplibre_gl_platform_interface
ref: main
maplibre_gl_web:
git:
url: https://github.com/m0nac0/flutter-maplibre-gl.git
url: https://github.com/maplibre/flutter-maplibre-gl.git
path: maplibre_gl_web
ref: main

Expand Down