Skip to content

Commit 9f33ecf

Browse files
committed
change README
1 parent e0f06cf commit 9f33ecf

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,43 @@ and the Flutter guide for
1111
[developing packages and plugins](https://flutter.dev/developing-packages).
1212
-->
1313

14-
TODO: Put a short description of the package here that helps potential users
15-
know whether this package might be useful for them.
14+
A simple state management solution that combine the power of inherited widget and rxdart
1615

1716
## Features
1817

19-
TODO: List what your package can do. Maybe include images, gifs, or videos.
18+
Create state management logic for your app using multitude of blocs, which internal
19+
is just stream and rxdart, you can access them anywhere in your widget tree when
20+
provided using providers.
2021

2122
## Getting started
2223

23-
TODO: List prerequisites and provide or point to information on how to
24-
start using the package.
24+
Started by providing blocs and service for your widget's subtree like this:
2525

26-
## Usage
26+
```dart
27+
class App extends StatelessWidget {
28+
const App({Key? key}) : super(key: key);
29+
30+
@override
31+
Widget build(BuildContext context) {
32+
return MaterialApp(
33+
home: RxProvider<CounterBloc>(
34+
create: () => CounterBloc(10),
35+
child: MyHomePage(),
36+
)
37+
);
38+
}
39+
}
40+
```
2741

28-
TODO: Include short and useful examples for package users. Add longer examples
29-
to `/example` folder.
42+
And then access them anywhere in your subtree with:
3043

3144
```dart
32-
const like = 'sample';
45+
final bloc = RxProvider.of<CounterBloc>(context);
3346
```
3447

48+
## Usage
49+
50+
More details coming soon
51+
3552
## Additional information
3653

37-
TODO: Tell users more about the package: where to find more information, how to
38-
contribute to the package, how to file issues, what response they can expect
39-
from the package authors, and more.

0 commit comments

Comments
 (0)