chore(readme): sync library readme with repo readme

DerStimmler · May 30, 2024 · 417f8ed · 417f8ed
1 parent 5cfd0fa
commit 417f8ed
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/libs/ngx-parallax-stars/README.md b/libs/ngx-parallax-stars/README.md
@@ -7,7 +7,7 @@
 
 ![banner](https://raw.githubusercontent.com/DerStimmler/ngx-parallax-stars/master/ngx-parallax-stars-banner.gif)
 
-Angular library to create beautiful stars with parallax effect.
+Angular library to create beautiful stars with parallax effect
 
 ## Demo
 
@@ -67,20 +67,29 @@ layers: StarLayer[] = [
     density: 7,
     size: 1,
     direction: 'up',
+    blur: 5,
+    glow: 1,
+    isRound: false,
   },
   {
     color: '#ffffff',
     speed: 15,
     density: 2,
     size: 2,
     direction: 'up',
+    blur: 1,
+    glow: 2,
+    isRound: false,
   },
   {
     color: '#ffffff',
     speed: 20,
     density: 1,
     size: 3,
     direction: 'up',
+    blur: 0,
+    glow: 5,
+    isRound: false,
   }
 ];
 ```
@@ -96,6 +105,9 @@ layers: StarLayer[] = [
 | `density: number`   | Specifies how many stars should be rendered per 100 by 100px area                                                                      |
 | `size: number`      | Specifies the size of every star in px                                                                                                 |
 | `direction: string` | Determines the moving direction. Possible values are: `up`, `down`, `left`, `right`                                                    |
+| `blur: number`      | Sets the amount of blur for every star                                                                                                 |
+| `glow: number`      | Sets the glow radius in px                                                                                                             |
+| `isRound: boolean`  | Set to true to make the stars round instead of square                                                                                  |
 
 When you update the layers input binding, the component will automatically be re-rendered.