Describe Mapbox setup in new Flutter project

tomwyr · tobrun · commit 87a82839450d · 2018-05-28T11:24:36.000+02:00
diff --git a/README.md b/README.md
@@ -11,15 +11,49 @@ embedded interactive and customizable vector maps inside of a Flutter widget. Th
 
 ### Android
 
-This demo app uses Mapbox vector tiles, which require a Mapbox account and a Mapbox access token. Obtain a free access token on [your Mapbox account page](https://www.mapbox.com/account/access-tokens/).
+Following examples use Mapbox vector tiles, which require a Mapbox account and a Mapbox access token. Obtain a free access token on [your Mapbox account page](https://www.mapbox.com/account/access-tokens/). After you get the key, place it in project's Android directory:
+- Create a `local.properties` file with the following path: `$project_dir/android/local.properties`
+- Add `mapbox.accessToken="YOUR MAPBOX ACCESS TOKEN"`
+ token to the **local.properties** file.
+ 
+#### Demo app
 
 - Install [Flutter](https://flutter.io/get-started/) and validate its installation with `flutter doctor`
 - Clone this repository with `git clone git@github.com:mapbox/flutter-mapbox-gl.git`
-- Create a `local.properties` file with the following path: `flutter_mapbox/example/android/local.properties`
-- Add `mapbox.accessToken="YOUR MAPBOX ACCESS TOKEN"`
- token to the **local.properties** file.
 - Run the app with `cd flutter_mapbox/example && flutter run`
 
+#### New project
+
+- Create new Flutter project in your IDE or via terminal
+- Add `mapbox_gl: ^0.0.1` dependency to `pubspec.yaml` file and [get the package](https://flutter.io/using-packages/#adding-a-package-dependency-to-an-app)
+- Add Mapbox dependency and read token value in Android module `build.gradle` file:
+```
+android {
+    defaultConfig {
+        // ...
+        def mapboxAccessToken = localProperties.getProperty('mapbox.accessToken')
+        buildConfigField "String", "MAPBOX_ACCESS_TOKEN", "$mapboxAccessToken"
+    }
+}
+
+dependencies {
+    // ...
+    implementation "com.mapbox.mapboxsdk:mapbox-android-sdk:6.1.0-SNAPSHOT"
+}
+```
+- Initialize Mapbox in Android `MainActivity` class:
+```
+override fun onCreate(savedInstanceState: Bundle?) {
+  // ...
+  Mapbox.getInstance(this, BuildConfig.MAPBOX_ACCESS_TOKEN)
+}
+```
+- Import Mapbox widgets and add them to your widget tree
+```
+import 'package:mapbox_gl/controller.dart';
+import 'package:mapbox_gl/flutter_mapbox.dart';
+import 'package:mapbox_gl/overlay.dart';
+```
 
 ## Documentation
 
@@ -39,4 +73,4 @@ This README file currently houses all of the documentation for this Flutter proj
 
 We welcome contributions to this repository!
 
-If you're interested in helping build this Mapbox/Flutter integration, please read [the contribution guide](https://github.com/mapbox/flutter-mapbox-gl/blob/master/CONTRIBUTING.md) to learn how to get started.
+If you're interested in helping build this Mapbox/Flutter integration, please read [the contribution guide](https://github.com/mapbox/flutter-mapbox-gl/blob/master/CONTRIBUTING.md) to learn how to get started.
