📝 improve readme file

Odonno · Dec 2, 2022 · 4676bfc · 4676bfc
1 parent a107ef4
commit 4676bfc
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,17 @@
 # NgrxWatchComponentStore
 
+Simplify debugging of ngrx's ComponentStore
+
 ```
 npm i ngrx-watch-component-store
 ```
 
+### Introduction
+
+The goal of this library is to display log on each ComponentStore state update. Here is what you can get in your Chrome DevTools:
+
+![./images/logs.png](./images/logs.png)
+
 ### How to use?
 
 Simply add `WatchComponentState` decorator on each `ComponentStore` in your app. See for yourself:

diff --git a/images/logs.png b/images/logs.png
diff --git a/projects/ngrx-watch-component-store/README.md b/projects/ngrx-watch-component-store/README.md
@@ -1,9 +1,17 @@
 # NgrxWatchComponentStore
 
+Simplify debugging of ngrx's ComponentStore
+
 ```
 npm i ngrx-watch-component-store
 ```
 
+### Introduction
+
+The goal of this library is to display log on each ComponentStore state update. Here is what you can get in your Chrome DevTools:
+
+![./images/logs.png](./images/logs.png)
+
 ### How to use?
 
 Simply add `WatchComponentState` decorator on each `ComponentStore` in your app. See for yourself: