From b4c8f56b38b355b001d6a0a1fe8cca6f9621875a Mon Sep 17 00:00:00 2001
From: Diego Zepeda <38699812+diezep@users.noreply.github.com>
Date: Fri, 31 Jul 2020 21:51:57 -0500
Subject: [PATCH] Update README.md
---
README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++----------
1 file changed, 53 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 900539d..0e3c8e2 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,62 @@
-# Heroku × Flutter
-Compile and deploy your Flutter Web projects automatically on Heroku easily.
+# Heroku Buildpack for Flutter
+
+Automate your deployments on Heroku easily.
## 🔨 Setup
-#### 1. Add this buildpack in your Heroku app.
+
+#### Add this Buildpack in your Heroku app
+
You can copy the [link](https://github.com/diezep/heroku-buildpack-flutter) of this repository and paste it in buildpacks or write **diezep/flutter** and will be added automatically.
-#### 2. Add PHP buildpack in your Heroku app.
- Is necessary add PHP buildpack **after** this buildpack.
-
- PHP Buildpack is needed to run the static files in a web service that can be opened in browsers.
- *You can skip this step if you have another way to deploy statics files, like NodeJS, Flask..*
-#### **IMPORTANT:**
+#### Optional
+
+ You can add optional [environment variables](#--environment-variables) to customize the deployment of your project but nothing is required, all are optional.
+
+#### Problems to compile
By default, this buildpack get the **last version** of Flutter automatically, sometimes because is on beta channel, that version may have problems to compile a project with web support.
If this is your case, you can try downgrade the Flutter version manually, add FLUTTER_VERSION variable in your Heroku environment with the number of the most recent version that are currently working correctly.
-**[UPDATED] Last working version:** 1.19.0-4.3.pre
+**Last working version :** 1.19.0-4.3.pre
+
+## 🚩 TODO :
+
+### Environment variables :
+
+* [x] VERSION to set the name of custom version of Flutter.
+* [x] CLEANUP to remove uneccessary files after the build.
+* [ ] CACHE to remove and download every file its need to compile the project in every deploy.
+* [ ] SUBDIR to ubicate the project if it isn't in a root directory.
+
+### Features :
+
+* [x] No more PHP Buildpack needed.
+* [x] Save and restore Flutter and Dart SDK in cache.
+* [x] Save and restore [dhttpd](https://github.com/diezep/dhttpd) in cache.
+* [ ] Save and restore project dependencies needed in cache.
+
+## 🚧 Environment variables:
+
+All variables were built following the structure **FLUTTER_VARNAME** to identified easily in Heroku configurations. If you want to use some variable, remember **use the structure** following to the variable.
+
+| Variable | Type | Default | Description
+|----------|---------|------------------| -------------------|
+| CLEANUP | *boolean* | true |Remove **uneccessary files** of your project after the compile. |
+| VERSION | *string* | *Last version in [beta channel](https://flutter.dev/docs/development/tools/sdk/releases?tab=linux).* | The **name of the version** you want to use to compile the project.|
+
+### Set variable
+ Example of setting CLEANUP var in Heroku CLI:
+ ```shellscript
+ $ heroku config:set FLUTTER_CLEANUP=true -a project-name
+ ```
+### Example
+
+The next image is an example of setting environment variables following the structure mentioned above :
+
+
+
+
+
-And that's it, your web page will be ready in a few minutes.
+## 📝 Final note
+ This buildpack is unofficial that means i don't have any conection with Heroku or Google from Flutter developer team . This repository was made as a hobby, i'm always interested in learn new things, this is one demostration of that :)
\ No newline at end of file