README.md

Author: hoc081098

README.md

@@ -11,35 +11,35 @@ Base class, BLoC provider and `rxdart` builder for BLoC pattern in Flutter.
 
 ## Getting Started
 
-### 1. Add this to your package's pubspec.yaml file:
+### 1. Add this to your package's pubspec.yaml file
 
 ```yaml
 dependencies:
   flutter_bloc_pattern: <latest_version>
 ```
 
-### 2. Now in your Dart code, you can use:
+### 2. Implements BaseBloc
 
 ```dart
+import 'package:disposebag/disposebag.dart';
 import 'package:flutter_bloc_pattern/flutter_bloc_pattern.dart';
-```
+import 'package:rxdart_ext/rxdart_ext.dart';
 
-### 3. Implements BaseBloc:
-```dart
 class MyBloc implements BaseBloc {
-  Stream<String> get stream;
+  StateStream<String> get stream;
 
   @override
   void dispose() {}
 }
 ```
 
-### 4. Consume BLoC:
+### 3. Consume BLoC
+
 ```dart
  final bloc = BlocProvider.of<MyBloc>(context);
- return RxStreamBuilder(
+ return RxStreamBuilder<String>(
   stream: bloc.stream,
-  builder: (context, data) {
+  builder: (context, state) {
     return ...;
   },
 );

example/README.md

@@ -1,6 +1,54 @@
-[Simple example](https://github.com/hoc081098/flutter_bloc_pattern/tree/master/example/counter) a port of the standard "Counter Button" example from Flutter.
+# flutter_bloc_pattern
+
+Base class, BLoC provider and `rxdart` builder for BLoC pattern in Flutter.
+
+[![Flutter test](https://github.com/hoc081098/flutter_bloc_pattern/workflows/Flutter%20test/badge.svg)](https://github.com/hoc081098/flutter_bloc_pattern/actions)
+[![Pub](https://img.shields.io/pub/v/flutter_bloc_pattern.svg)](https://pub.dev/packages/flutter_bloc_pattern)
+[![Pub](https://img.shields.io/pub/v/flutter_bloc_pattern?include_prereleases)](https://pub.dev/packages/flutter_bloc_pattern)
+[![codecov](https://codecov.io/gh/hoc081098/flutter_bloc_pattern/branch/master/graph/badge.svg?token=yhrC5lmOqu)](https://codecov.io/gh/hoc081098/flutter_bloc_pattern)
+[![GitHub](https://img.shields.io/github/license/hoc081098/flutter_bloc_pattern?color=4EB1BA)](https://opensource.org/licenses/MIT)
+[![Style](https://img.shields.io/badge/style-pedantic-40c4ff.svg)](https://github.com/dart-lang/pedantic)
+
+## Getting Started
+
+### 1. Add this to your package's pubspec.yaml file
+
+```yaml
+dependencies:
+  flutter_bloc_pattern: <latest_version>
+```
+
+### 2. Implements BaseBloc
+
+```dart
+import 'package:disposebag/disposebag.dart';
+import 'package:flutter_bloc_pattern/flutter_bloc_pattern.dart';
+import 'package:rxdart_ext/rxdart_ext.dart';
+
+class MyBloc implements BaseBloc {
+  StateStream<String> get stream;
+
+  @override
+  void dispose() {}
+}
+```
+
+### 3. Consume BLoC
+
+```dart
+ final bloc = BlocProvider.of<MyBloc>(context);
+ return RxStreamBuilder<String>(
+  stream: bloc.stream,
+  builder: (context, state) {
+    return ...;
+  },
+);
+```
+
+## Example: A port of the standard "Counter Button" example from Flutter
+
+### 1. File `counter_bloc.dart`
 
-### 1. File `counter_bloc.dart`:
 ```dart
 import 'dart:async';
 
@@ -37,117 +85,34 @@ class CounterBloc extends DisposeCallbackBaseBloc {
 }
 ```
 
-### 2. File `main.dart`:
+### 2. File `main.dart`
+
 ```dart
 import 'package:example/bloc.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc_pattern/flutter_bloc_pattern.dart';
 
-void main() => runApp(MyApp());
-
-class MyApp extends StatelessWidget {
-  @override
-  Widget build(BuildContext context) {
-    return MaterialApp(
-      title: 'Flutter bloc pattern',
-      theme: ThemeData(
-        primarySwatch: Colors.blue,
-      ),
-      home: StartPage(),
-    );
-  }
-}
-
-class StartPage extends StatelessWidget {
-  @override
-  Widget build(BuildContext context) {
-    return Container(
-      child: Center(
-        child: TextButton(
-          onPressed: () => Navigator.of(context).push(
-            MaterialPageRoute(
-              builder: (context) {
-                return BlocProvider<CounterBloc>(
-                  child: MyHomePage(),
-                  initBloc: () => CounterBloc(),
-                );
-              },
-            ),
-          ),
-          child: Text('GO TO HOME'),
-        ),
-      ),
-    );
-  }
-}
-
-class MyHomePage extends StatefulWidget {
-  @override
-  _MyHomePageState createState() => _MyHomePageState();
-}
-
-class _MyHomePageState extends State<MyHomePage> {
-  @override
-  Widget build(BuildContext context) {
-    return Scaffold(
-      appBar: AppBar(
-        title: Text('Home page'),
-      ),
-      body: Center(
-        child: Column(
-          mainAxisAlignment: MainAxisAlignment.center,
-          children: const <Widget>[
-            Text('You have pushed the button this many times:'),
-            TextCounter1(),
-            TextCounter2(),
-          ],
-        ),
-      ),
-      floatingActionButton: const IncrementButton(),
-    );
-  }
-}
-
 class TextCounter1 extends StatelessWidget {
-  const TextCounter1({Key? key}) : super(key: key);
+  const TextCounter1({super.key});
 
   @override
   Widget build(BuildContext context) {
     final bloc = BlocProvider.of<CounterBloc>(context);
 
     return RxStreamBuilder<int>(
       stream: bloc.state,
-      builder: (context, data) {
-        return Text(
-          'COUNTER 1: $data',
-          style: Theme.of(context).textTheme.headline4,
-        );
-      },
-    );
-  }
-}
-
-class TextCounter2 extends StatelessWidget {
-  const TextCounter2({Key? key}) : super(key: key);
-
-  @override
-  Widget build(BuildContext context) {
-    final bloc = context.bloc<CounterBloc>();
-
-    return RxStreamBuilder<int>(
-      stream: bloc.state,
-      builder: (context, data) {
+      builder: (context, state) {
         return Text(
-          'COUNTER 2: $data',
-          style: Theme.of(context).textTheme.headline4,
+          'COUNTER 1: $state',
+          style: Theme.of(context).textTheme.titleLarge,
         );
       },
     );
   }
 }
 
 class IncrementButton extends StatelessWidget {
-  const IncrementButton({Key? key}) : super(key: key);
+  const IncrementButton({super.key});
 
   @override
   Widget build(BuildContext context) {
@@ -156,7 +121,7 @@ class IncrementButton extends StatelessWidget {
     return FloatingActionButton(
       onPressed: bloc.increment,
       tooltip: 'Increment',
-      child: Icon(Icons.add),
+      child: const Icon(Icons.add),
     );
   }
 }