diff --git a/README.md b/README.md index 09bf4c0..e47f26a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -
-
Fl-Query
@@ -151,3 +149,10 @@ Yes but it is only if your commercial server has huge load of power & you're mad
**So `FutureProvider` from riverpod or provider not enough?**
Yeah, indeed its more than enough for many applications but what if your app needs Optimistic Updates & proper server-state synchronization or simply want a custom `cacheTime`? Although `FutureProvider` is a viable solution most of the `Future` related stuff, why not kick it up a notch with smart refetching capabilities with proper server-state synchronization?
Riverpod is definitely a inspiration for Fl-Query & the `QueryJob` is actually inspired by riverpod & imo is the best state management solution any library has ever provided but that's still a client state manager just like other client state manager or synchronous data manager
+
+
+# Notice Board
+
+This project is currently under heavy development & not yet production ready. There are lot of features to cover. If anyone encounters any unintended behavior or any bug please report it. Also we're open to improvement suggestions & feature requests
+
+**Important!:** The project needs Dart-Flutter developers who are willing to contribute to the project by writing Tests. (I'm the worst example for tester)
\ No newline at end of file
diff --git a/assets/fl-query-banner.png b/assets/fl-query-banner.png
new file mode 100644
index 0000000..93e8ea8
Binary files /dev/null and b/assets/fl-query-banner.png differ
diff --git a/docs/README.md b/docs/README.md
index aaba2fa..bbb5d0e 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,41 +1,3 @@
-# Website
+# Docs for Fl-Query
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
-
-### Installation
-
-```
-$ yarn
-```
-
-### Local Development
-
-```
-$ yarn start
-```
-
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-### Build
-
-```
-$ yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=
-
Fl-Query
@@ -151,3 +149,10 @@ Yes but it is only if your commercial server has huge load of power & you're mad
**So `FutureProvider` from riverpod or provider not enough?**
Yeah, indeed its more than enough for many applications but what if your app needs Optimistic Updates & proper server-state synchronization or simply want a custom `cacheTime`? Although `FutureProvider` is a viable solution most of the `Future` related stuff, why not kick it up a notch with smart refetching capabilities with proper server-state synchronization?
Riverpod is definitely a inspiration for Fl-Query & the `QueryJob` is actually inspired by riverpod & imo is the best state management solution any library has ever provided but that's still a client state manager just like other client state manager or synchronous data manager
+
+
+# Notice Board
+
+This project is currently under heavy development & not yet production ready. There are lot of features to cover. If anyone encounters any unintended behavior or any bug please report it. Also we're open to improvement suggestions & feature requests
+
+**Important!:** The project needs Dart-Flutter developers who are willing to contribute to the project by writing Tests. (I'm the worst example for tester)
\ No newline at end of file
diff --git a/packages/fl_query_hooks/README.md b/packages/fl_query_hooks/README.md
index 2892db4..aaebb5f 100644
--- a/packages/fl_query_hooks/README.md
+++ b/packages/fl_query_hooks/README.md
@@ -1,6 +1,4 @@
-
-
Fl-Query Hooks