Merge branch 'master' of github.com:passsy/flutter_wrapper

Author: passsy

README.md

@@ -1,75 +1,113 @@
 # Flutter Wrapper
 
-Similar to the gradle wrapper, an executable shell script in the root of you project, `flutterw` which downloads and runs flutter with the same version, part of your repository, for every user and CI.
+`flutterw` is a tiny, open source shell script which downloads and executes the Flutter SDK with the exact version defined in your project respository.
+It encourages the idea that upgrading Flutter should happen per project, not per developer.
+Thus upgrading Flutter with `flutterw` automatically upgrades Flutter for your co-workers and on the CI servers.
 
-The flutter wrapper will add flutter as a submodule to your project which pins the version allowing you to upgrade flutter for all developers in you project at the same time.
+The Flutter Wrapper will add the Flutter SDK as a git submodule to your project.
+It pins the version and the channel.
 
-Read the story on [Medium](https://medium.com/grandcentrix/flutter-wrapper-bind-your-project-to-an-explicit-flutter-release-4062cfe6dcaf)
+This project is inspired by the gradle wrapper.
 
-## How to use Flutter Wrapper
+Read more on [Medium](https://medium.com/grandcentrix/flutter-wrapper-bind-your-project-to-an-explicit-flutter-release-4062cfe6dcaf)
 
-### Add the Flutter Wrapper to your project
 
-Run this command from the root of your flutter project
+# Install flutterw
 
-> `sh -c "$(curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/install.sh)"`
-> 
-All required files are already added to git. You can commit them now 
+```bash
+sh -c "$(curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/install.sh)"
+```
+_Open the Terminal, navigate to your project root and execute the line above._
+
+From now on use `./flutterw` instead of `flutter`
+
+![flutterw terminal demo](https://user-images.githubusercontent.com/1096485/64660427-840dc080-d440-11e9-97a2-a9e2bef203bd.gif)
+
+## IDE Setup
+### Use with VScode
+
+If you're a VScode user link the new Flutter SDK path in your settings
+`$projectRoot/.vscode/settings.json` (create if it doesn't exists yet)
+
+```json
+{
+    "dart.flutterSdkPath": ".flutter",
+}
+```
+
+Commit this file to your git repo and your coworkers will automatically use `flutterw` from now on
+
+### Use with IntelliJ / Android Studio
+
+Go to `Preferences > Languages & Frameworks > Flutter` and set the Flutter SDK path to `$projectRoot/.flutter`
 
-> `git commit -m "Add flutter wrapper"`
+<img width="800" alt="IntelliJ Settings" src="https://user-images.githubusercontent.com/1096485/64658026-3a1fdd00-d436-11e9-9457-556059f68e2c.png">
 
-From now on you should always use `./flutterw` instead of `flutter`
+Add this step to the onboarding guidelines of your projects because this has to be done for every developer for every project using `flutterw`.
 
-### Update Flutter
+
+## Tips and Tricks
+### Upgrading Flutter
 
 Flutter Wrapper doesn't require any special command to update Flutter.
-Run `./flutterw channel <stable|beta|master>` to change the channel or update to the lastest version of a given channel.
+Run `./flutterw channel <stable|beta|dev|master>` to change the channel or update to the lastest version of a given channel.
 
-> `./flutterw channel stable` 
+```
+./flutterw channel beta
+./flutterw upgrade
+```
 
-The only change you'll see in git is the changed sha1 of the `.flutter` submodule.
-You have to commit it to update flutter for all project members.
+Don't forget to commit the submodule changes.  
 
 
-### Update flutter wrapper
+### Updating flutterw 
 
 To update the flutter wrapper to the latest version run the install command again:
 
-> `sh -c "$(curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/install.sh)"`
+```bash
+sh -c "$(curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/install.sh)"
+```
 
-To update the flutter wrapper to a specific verssion, use the `-t <tag/branch>` (i.e. `v0.8.0`)
+To update the flutter wrapper to a specific verssion, use the `-t <tag/branch>` (i.e. `v1.0.0`)
 
-> `sh -c "curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/install.sh" | bash /dev/stdin -t v1.0.0`
+```bash
+sh -c "curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/install.sh" | bash /dev/stdin -t v1.0.0
+```
 
-## Advanced Usage
 
-### Uninstall flutter wrapper
+### Uninstall flutterw
 
+Sorry to let you go!
 Removing submodules is hard, that's why I did the hard work for you.
 Simply run this command from the root of your flutter project and the uninstall script will cleanup everything.
 
-> `sh -c "$(curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/uninstall.sh)"`
+```bash
+sh -c "$(curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/uninstall.sh)"
+```
 
 Bye :wave:
 
-### Get started with Flutter without adding flutter to your PATH
+### Create a new project using the flutter wrapper
 
-The [Flutter install process](https://flutter.io/setup-macos/#get-sdk) is not perfectly automated.
-You have to manually download Flutter and add it to your path before you can use the awesome Flutter CLI to create a new project.
-With the Flutter Wrapper this becomes easier.
+You can create a new Flutter project without installing Flutter globally on your machine.
 
 ```bash
+# 1. Create an empty git repo
 mkdir flutter_wrapper_project && cd "$_"
 git init
+
+# 2. Install flutterw
 sh -c "$(curl -fsSL https://raw.githubusercontent.com/passsy/flutter_wrapper/master/install.sh)"
+
+# 3. Create Flutter project
 ./flutterw create .
 ./flutterw run
 ```
 
 ## License
 
 ```
-Copyright 2018 Pascal Welsch
+Copyright 2019 Pascal Welsch
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.