chore: prepare release 0.0.1

.github/workflows/check-docs.yml → .github/workflows/docs.yml

@@ -6,6 +6,11 @@ on:
   pull_request:
   workflow_dispatch:
 
+# Ensure that new pushes/updates cancel running jobs
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build:
     defaults:
@@ -17,10 +22,9 @@ jobs:
         uses: actions/checkout@v4
       - name: Set up Node.js
         uses: actions/setup-node@v4
-        # Can't use cache because build fails with "Dependencies lock file is not found"
-        # with:
-        #  cache: yarn
+#        with:
+#          cache: yarn
       - name: Install dependencies
-        run: yarn install --frozen-lockfile --non-interactive
+        run: yarn install --immutable
       - name: Build
         run: yarn build

.github/workflows/flutter-ci.yml

@@ -114,11 +114,3 @@ jobs:
         run: dart pub get
       - name: Build web
         run: flutter build web
-#      - name: Deploy to GitHub Pages
-#        if: github.repository_owner == 'josxha'
-#        uses: peaceiris/actions-gh-pages@v4
-#        with:
-#          github_token: ${{ secrets.GITHUB_TOKEN }}
-#          publish_dir: example/build/web
-#          destination_dir: demo
-#          keep_files: true

.pubignore

@@ -0,0 +1,3 @@
+docs/
+example/assets/
+pigeons/

CHANGELOG.md

@@ -1,3 +1,7 @@
-## 0.1.0
+## 0.0.1
 
-* TODO: Describe initial release.
+### New features
+
+- Initial release
+- Implement map for android and web
+- Add docs

README.md

@@ -9,59 +9,58 @@
 [![stars](https://badgen.net/github/stars/josxha/flutter-maplibre?label=stars&color=green&icon=github)](https://github.com/josxha/flutter-maplibre/stargazers)
 [![GitHub issues](https://img.shields.io/github/issues/josxha/flutter-maplibre)](https://github.com/josxha/flutter-maplibre/issues)
 
-This package provides unofficial Flutter bindings for MapLibre libraries.
+This package provides unofficial Flutter bindings for MapLibre SDKs.
 
 - [maplibre-gl-js](https://github.com/maplibre/maplibre-gl-js) is used for web
 - [maplibre-native](https://github.com/maplibre/maplibre-native) (previously
   named maplibre-gl) is used for android and in the future for iOS,
   windows, macOS and Linux
 
-### What is the difference to [maplibre_gl](https://pub.dev/packages/maplibre_gl)?
-
-Both, `maplibre_gl` and `maplibre` try to solve the same purpose to create
-bindings between the
-platform specific MapLibre SDK and Flutter. `maplibre_gl` is a fork
-of `mapbox_gl` and already some
-years around. `maplibre` on the other hand is a brand new and fresh
-implementation. It tries to
-provide the following improvements:
-
-1. A WebAssembly compatible web implementation using the new JavaScript interop
-   from `package:web`
-   and `js_interop`.
-2. Zero cost JavaScript interop
-   using [extension types](https://dart.dev/language/extension-types)
-   that got delivered
-   in [Dart 3.3](https://medium.com/dartlang/dart-3-3-325bf2bf6c13).
-3. More type safety and reducing the amount of platform custom code using code
-   generation with [pigeon](https://pub.dev/packages/pigeon).
-4. No legacy code or workarounds in the code base (with the risk of not yet
-   including necessary
-   fixes).
-5. Get rid of code where the licensing is not clear. For example some files
-   have
-   a `Copyright 2018 The Chromium Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.`
-   header but the LICENSE file doesn't mention it.
-6. Using Kotlin instead of Java to benefit from null safety and reduce potential
-   NullPointerExceptions.
-7. Keep all platforms in one package to simplify the release cycle. Having
-   multiple packages is a potential cause of bugs (e.g.
-   https://github.com/maplibre/flutter-maplibre-gl/pull/476)
-8. Use [geotypes](https://pub.dev/packages/geotypes) which are
-   GeoJSON compatible
-   ([RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946) compliant). This
-   makes it compatible with all the functionality
-   from [dart_turf](https://pub.dev/packages/turf).
-   from [dart_turf](https://pub.dev/packages/turf).
+MapLibre is a permissive and open source solution for the MVT 
+(Mapbox Vector Tile) standard. By binding to native SDKs the package 
+accomplishes performant rendering while supporting a lot of complex 
+functionality.
+
+<table>
+<thead>
+<th>Use custom styles for your map</th>
+<th>Tilt or rotate your map</th>
+</thead>
+<tbody>
+<tr>
+<td><img src="https://private-user-images.githubusercontent.com/34318751/366865128-9871beb1-9887-4970-8ece-f8e3cb26f5c8.jpg?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjYxNDM2MjQsIm5iZiI6MTcyNjE0MzMyNCwicGF0aCI6Ii8zNDMxODc1MS8zNjY4NjUxMjgtOTg3MWJlYjEtOTg4Ny00OTcwLThlY2UtZjhlM2NiMjZmNWM4LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTEyVDEyMTUyNFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTg1NDEwMTFjYWJkZjZmYzFmYmIyNjRlNjMyMTE5ZGI0ZWI0YmJiMWE4NGNkNGNlNmRjZmM5MDgzMjNhZGViZDkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.rHi7xVLk-vP_3X_Cpi550-GcU7F5oKvPaBK2xf83Ks0" alt="Custom styled map" /></td>
+<td><img src="https://private-user-images.githubusercontent.com/34318751/366865159-eab6cf27-38cb-4111-9900-b109f86df57e.jpg?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjYxNDM2MjQsIm5iZiI6MTcyNjE0MzMyNCwicGF0aCI6Ii8zNDMxODc1MS8zNjY4NjUxNTktZWFiNmNmMjctMzhjYi00MTExLTk5MDAtYjEwOWY4NmRmNTdlLmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTEyVDEyMTUyNFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTBkYzkzZjZhYjQ2Yzk4YWMxZjdlZGZhN2E3OTdhZWYzNjNkNGU0NDBkM2MyMzAzMTIyM2MwNTBjNjRjMTRkOGEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.-AlEyjQ_qAYfgK0T6zddggZF3UU1Ck1VwB3-Ow9gCtg" alt="Tilted and rotated map" /></td>
+</tr>
+</tbody>
+</table>
+
+## Resources
+
+### Demo Application
+
+Check out the [hosted demo application](https://flutter-maplibre.pages.dev/demo)
+or dive into
+the [example app code](https://github.com/josxha/flutter-maplibre/tree/main/example/lib).
+
+### Get started & Documentation
+
+Visit the docs to learn how to get started with maplibre in your
+project: [Get Started](https://flutter-maplibre.pages.dev/docs/get-started)
+
+If you want to know more about the classes and properties of the package, have
+a look at
+the [API docs](https://pub.dev/documentation/maplibre/latest/maplibre/maplibre-library.html).
 
 ### State of implementation
 
-See https://josxha.github.io/flutter-maplibre/docs/features/supported-features
+This package is still a young package and in an early stage.
+While it offers a modern implementation, it currently lacks some
+functionality. [See our documentation to learn more.](https://flutter-maplibre.pages.dev/docs/features/supported-features)
 
 ## Development & Contributing
 
 If you need a feature or experience a bug you want to fix contributions are
-always welcome.
+welcome.
 
 ### Run code generation