docs: add warning for circular dependency

Author: Anxhul10

CHANGELOG.md

@@ -1,5 +1,11 @@
 ## 0.3.0
 
+## 0.3.1
+
+### Patch Changes
+
+- add warning before using getAffected package on circular dependent monorepo
+
 ### Minor Changes
 
 - add getAffectedPkg function which return the dependents including direct, transitive and circular dependency

README.md

@@ -11,6 +11,9 @@ npm install dag-rs
 yarn add dag-rs
 ```
 
+> [!NOTE]
+> Right now  `getAffectedPkg` doesnt support circular dependency it might log `[1]    867885 segmentation fault (core dumped)  node usage.cjs
+
 ## Usage
 
 ### CommonJS
@@ -40,7 +43,7 @@ for (const obj of getAffectedPkg("@rocket.chat/fuselage")) {
 ```
 
 ## Example Output :
-### getAffectedPkg("@rocket.chat/fuselage") → returns all the direct , transitive , circular dependency 
+### getAffectedPkg("@rocket.chat/fuselage") → returns all the direct , transitive dependencies
 ```
 // dependents of @rocket.chat/fuselage package
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dag-rs",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "",
   "main": "lib/index.js",
   "publishConfig": {