Updated example

Author: ShadyBoukhary

example/lib/src/app/pages/home/home_controller.dart

@@ -10,9 +10,11 @@ class HomeController extends Controller {
   int get counter => _counter;
   User get user => _user; // data used by the View
   final HomePresenter homePresenter;
+  // Presenter should always be initialized this way
   HomeController(usersRepo): _counter = 0, homePresenter = HomePresenter(usersRepo), super();
 
   @override
+  // this is called automatically by the parent class
   void initListeners() {
     homePresenter.getUserOnNext = (User user) { 
       print(user.toString());
@@ -42,7 +44,7 @@ class HomeController extends Controller {
 
   @override
   void dispose() {
-    homePresenter.dispose();
+    homePresenter.dispose();  // don't forget to dispose of the presenter
     super.dispose();
   }
 

example/lib/src/app/pages/home/home_view.dart

@@ -25,7 +25,7 @@ class _HomePageState extends ViewState<HomePage, HomeController> {
         title: Text(widget.title),
       ),
       body: Scaffold(
-        key: globalKey,
+        key: globalKey, // built in global key for the ViewState for easy access in the controller
         body: Center(
           child: Column(
             mainAxisAlignment: MainAxisAlignment.center,

example/lib/src/domain/usecases/get_user_usecase.dart

@@ -30,11 +30,13 @@ class GetUserUseCase extends UseCase<GetUserUseCaseResponse, GetUserUseCaseParam
   }
 }
 
+/// Wrapping params inside an object makes it easier to change later
 class GetUserUseCaseParams {
   final String uid;
   GetUserUseCaseParams(this.uid);
 }
 
+/// Wrapping response inside an object makes it easier to change later
 class GetUserUseCaseResponse {
   final User user;
   GetUserUseCaseResponse(this.user);

example/pubspec.lock

@@ -47,7 +47,7 @@ packages:
       name: flutter_clean_architecture
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.0.1"
+    version: "1.0.1"
   flutter_test:
     dependency: "direct dev"
     description: flutter

example/pubspec.yaml

@@ -23,7 +23,7 @@ dependencies:
   # The following adds the Cupertino Icons font to your application.
   # Use with the CupertinoIcons class for iOS style icons.
   cupertino_icons: ^0.1.2
-  flutter_clean_architecture: ^0.0.1
+  flutter_clean_architecture: ^1.0.2
   rxdart: ^0.20.0
 dev_dependencies:
   flutter_test: