license and links to releases

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Sandro Maglione
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -14,7 +14,7 @@
 
 This app is a complete setup for a production ready [**Flutter**](https://flutter.dev/) application using [**Supabase**](https://supabase.com/) for [authentication](https://supabase.com/docs/guides/auth), [database](https://supabase.com/docs/guides/database), [storage](https://supabase.com/docs/guides/storage), and [more](https://supabase.com/docs/).
 
-## How to run the app
+## 🚀 How to run the app 
 
 > Make sure you [installed](https://docs.flutter.dev/get-started/install) Flutter and Dart in your machine
 
@@ -36,9 +36,6 @@ flutter packages pub run build_runner build
 4. Update [`.vscode/launch.json`](.vscode/launch.json) `args` with your Supabase project URL (`SUPABASE_URL`) and Key (`SUPABASE_ANNON_KEY`):
 ```json
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
     {
@@ -56,39 +53,39 @@ flutter packages pub run build_runner build
 ```
 5. Run the app 🚀
 
-## Structure of the project
+## 🧱 Structure of the project
 The project is organized in [releases](https://github.com/SandroMaglione/flutter-supabase-template/releases), each containing a specific set of changes for **one feature**:
-1. [Environment variables](https://github.com/SandroMaglione/flutter-supabase-template/releases/tag/v1-env-vars) 
-2. [Routing (`auto_route`)](https://github.com/SandroMaglione/flutter-supabase-template/releases/tag/v2-navigation) 
-3. [Dependency injection (`injectable`)](https://github.com/SandroMaglione/flutter-supabase-template/releases/tag/v3-dep-injection) 
-4. [Supabase authentication](https://github.com/SandroMaglione/flutter-supabase-template/releases/tag/v4-supabase-auth) 
+1. [Environment variables](https://github.com/SandroMaglione/flutter-supabase-template/tree/v1-env-vars) 
+2. [Routing (`auto_route`)](https://github.com/SandroMaglione/flutter-supabase-template/tree/v2-navigation) 
+3. [Dependency injection (`injectable`)](https://github.com/SandroMaglione/flutter-supabase-template/tree/v3-dep-injection) 
+4. [Supabase authentication](https://github.com/SandroMaglione/flutter-supabase-template/tree/v4-supabase-auth) 
 
-You can review each set of changes individually by [**looking at each PR merged**](https://github.com/SandroMaglione/flutter-supabase-template/pulls?q=is%3Apr+is%3Aclosed).
+You can review each set of changes individually by [**looking at each release**](https://github.com/SandroMaglione/flutter-supabase-template/tags).
 
 > **Note**: Each feature is build on top of the previous one.
 
-### Packages used ([pubspec.yaml](pubspec.yaml))
+### 📃 Packages used ([pubspec.yaml](pubspec.yaml))
 - [supabase_flutter](https://pub.dev/packages/supabase_flutter): Supabase SDK for Flutter's applications
 - [auto_route](https://pub.dev/packages/auto_route): Routing and navigation using auto-generation
 - [injectable](https://pub.dev/packages/injectable) ([get_it](https://pub.dev/packages/get_it)): Dependency injection using auto-generation
 
 > **Note**: This setup is opinionated. There are many other possible solutions and packages to achieve the same (or better) result. It would be interesting to start a discussion about each solution (by [opening new PRs](https://github.com/SandroMaglione/flutter-supabase-template/pulls) implementing other options)
 
-## Guides and tutorials
+## 👨🏼‍🏫 Guides and tutorials
 Each feature in the app has a [**blog post**](https://www.sandromaglione.com/) associated with it that explains more in the details the changes made:
 1. [Environment variables](https://www.sandromaglione.com/techblog/how-to-use-environmental-variables-in-flutter)
 2. [Routing (`auto_route`)](https://www.sandromaglione.com/techblog/how-to-setup-routing-flutter-app)
 3. [Dependency injection (`injectable`)](https://www.sandromaglione.com/techblog/how_to_implement_dependecy_injection_in_flutter)
-4. Supabase authentication [🔜]
+4. [Supabase authentication](https://www.sandromaglione.com/techblog/flutter-supabase-authentication-complete-tutorial)
 
-## Roadmap
+## 🛣 Roadmap
 - [ ] Adding support for [Supabase database](https://supabase.com/docs/guides/database)
 - [ ] Adding support for [Supabase storage](https://supabase.com/docs/guides/storage)
 - [ ] Improving the code using [**fpdart**](https://pub.dev/packages/fpdart) (Functional Programming)
   - [ ] Using `TaskEither` in [`repository`](lib/app/repository) as return type
   - [ ] Convert less-specific types to more specific ones using guards (e.g. instead of `String` for `userId`, create a `UserId` type and check the validity using `Either`)
 
-## Contribution
+## 🙏🏼 Contribution
 Every feedback, feature request, and contribution is gladly accepted:
 - Create a [new issue request](https://github.com/SandroMaglione/flutter-supabase-template/issues)
 - Create a [new PR for contributions](https://github.com/SandroMaglione/flutter-supabase-template/pulls)