docs: ✏️ update README

ngneat · Nov 13, 2023 · 990ebfe · 990ebfe
1 parent 9c8c220
commit 990ebfe
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -155,7 +155,7 @@ import { DialogService, DialogRef } from '@ngneat/dialog';
 })
 export class MyVeryCommonDialogComponent {
   ref: DialogRef<Data> = inject(DialogRef);
-  
+
   constructor() {
     this.ref.updateConfig({
       height: '200px',
@@ -304,7 +304,7 @@ For each dialog instance you open you can specify all the global options and als
   - If a component is passed - the component's name (e.g. `MyCustomDialog`).
   - Otherwise, a random id is given.
 > [!Note]  
-> while not required, it is recommended to set it to prevent unwanted multiple instances of the same dialog.
+> while not required, it is recommended to set an id in order to prevent unwanted multiple instances of the same dialog.
 - `vcr` - A custom `ViewContainerRef` to use.
 - `data` - A `data` object that will be passed to the modal template or component.
 

diff --git a/libs/dialog/README.md b/libs/dialog/README.md
@@ -304,7 +304,7 @@ For each dialog instance you open you can specify all the global options and als
   - If a component is passed - the component's name (e.g. `MyCustomDialog`).
   - Otherwise, a random id is given.
 > [!Note]  
-> while not required, it is recommended to set it to prevent unwanted multiple instances of the same dialog.
+> while not required, it is recommended to set an id in order to prevent unwanted multiple instances of the same dialog.
 - `vcr` - A custom `ViewContainerRef` to use.
 - `data` - A `data` object that will be passed to the modal template or component.