From 3334603f8e3bc12709d93fd085835fe0c6699e6c Mon Sep 17 00:00:00 2001
From: Muhammad Rendra <mnrendra@users.noreply.github.com>
Date: Thu, 14 Nov 2024 01:33:04 +0700
Subject: [PATCH] docs: update readme (#48)

issues:
* docs: update readme (#47)

commits:
* docs: update readme (0ec42d9)
---
 README.md | 16 +++++-----------
 1 file changed, 5 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 9d1f99a..e30f7cc 100644
--- a/README.md
+++ b/README.md
@@ -54,15 +54,10 @@ stackTrace(
 )
 ```
 
-## Utils
+## Utilities
 ```javascript
 import {
-  /**
-   * A utility to validate a name or a list of names of stack traces that need to be skipped.
-   *
-   * @see https://github.com/mnrendra/validate-skipped-stacks
-   */
-  validateSkippedStacks
+  validateSkippedStacks // To validate a name or a list of names of stack traces that need to be skipped. More info: @see https://github.com/mnrendra/validate-skipped-stacks
 } from '@mnrendra/stack-trace'
 ```
 
@@ -70,10 +65,9 @@ import {
 ```typescript
 import type {
   CallSite, // NodeJS.CallSite
-  Options, // { limit?: number },
-  // @mnrendra/validate-skipped-stacks
-  SkippedStacks,
-  ValidSkippedStacks
+  Options, // @mnrendra/stack-trace options
+  SkippedStacks, // @mnrendra/validate-skipped-stacks input
+  ValidSkippedStacks // @mnrendra/validate-skipped-stacks output
 } from '@mnrendra/stack-trace'
 ```