docs: update readme (#102)

issues:
* docs: update readme (#100)

commits:
* docs: update readme (999937c)

Author: mnrendra

README.md

@@ -1,14 +1,26 @@
 # @mnrendra/stack-trace
 
-![version](https://img.shields.io/npm/v/@mnrendra/stack-trace)
-![types](https://img.shields.io/npm/types/@mnrendra/stack-trace)
-![size](https://img.shields.io/npm/unpacked-size/@mnrendra/stack-trace)
-![downloads](https://img.shields.io/npm/dm/@mnrendra/stack-trace)
-![license](https://img.shields.io/npm/l/@mnrendra/stack-trace)
+[![version](https://img.shields.io/npm/v/@mnrendra/stack-trace?logo=nodedotjs)](https://www.npmjs.com/package/@mnrendra/stack-trace?activeTab=versions)
+[![downloads](https://img.shields.io/npm/dm/@mnrendra/stack-trace)](https://npm-stat.com/charts.html?package=@mnrendra/stack-trace)
+[![size](https://packagephobia.now.sh/badge?p=@mnrendra/stack-trace)](https://packagephobia.com/result?p=%40mnrendra%2Fstack-trace)
+[![coverage](https://codecov.io/github/mnrendra/stack-trace/graph/badge.svg?token=LSNMMJVQ77)](https://app.codecov.io/gh/mnrendra/stack-trace)
+[![release](https://github.com/mnrendra/stack-trace/actions/workflows/release.yml/badge.svg)](https://github.com/mnrendra/stack-trace/actions/workflows/release.yml)
+[![semantic](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/mnrendra/stack-trace/commits/main)
+[![license](https://img.shields.io/npm/l/@mnrendra/stack-trace)](https://github.com/mnrendra/stack-trace/blob/main/LICENSE)
+
+A lightweight [stack trace](https://v8.dev/docs/stack-trace-api) utility to retrieve `CallSite` objects from a specific caller.
 
-A lightweight [stack trace](https://v8.dev/docs/stack-trace-api) utility to retrieve `CallSite` objects from a specific caller.<br/>
 *Useful for debugging, logging, or building tools that need to trace call origins at runtime.*
 
+## Features
+- ✅ Supports both **ES Modules** and **CommonJS** from a single source - see [package](https://www.npmjs.com/package/@mnrendra/stack-trace?activeTab=code)
+- ✅ Minified and cleansed of unnecessary dependencies, files, and attributes - see [contents](https://www.npmjs.com/package/@mnrendra/stack-trace?activeTab=code)
+- ✅ Tiny package - see [size](https://bundlephobia.com/package/@mnrendra/stack-trace)
+- ✅ Well tested - see [coverage](https://app.codecov.io/gh/mnrendra/stack-trace)
+- ✅ Verified all commits - see [signatures](https://github.com/mnrendra/stack-trace/commits/main)
+- ✅ Semantic versioning - see [commits](https://github.com/mnrendra/stack-trace/commits/main)
+- ✅ Actively maintained - [pull requests](https://github.com/mnrendra/stack-trace/pulls), [issues](https://github.com/mnrendra/stack-trace/issues), and [discussions](https://github.com/mnrendra/stack-trace/discussions) are welcome!
+
 ## Install
 ```bash
 npm i @mnrendra/stack-trace
@@ -129,26 +141,26 @@ If the extracted file name is not a string or not absolute.
 
 ## Usage
 
-### CommonJS
-`/foo/callee.cjs`
+### ES Modules
+`/foo/callee.mjs`
 ```javascript
-const { dirname } = require('node:path')
+import { dirname } from 'node:path'
 
-const {
+import {
   stackTrace,
   getCallerSite,
   extractFilePath,
   getCallerFile,
   getCallerDir
-} = require('@mnrendra/stack-trace')
+} from '@mnrendra/stack-trace'
 
 const callee = () => {
   // `stackTrace`:
   const [callSite1] = stackTrace()
   const [callSite2] = stackTrace(callee, { limit: 1 }) // Pass the `callee` function as the callee.
 
-  console.log(callSite1.getFileName()) // Output: /foo/callee.cjs
-  console.log(callSite2.getFileName()) // Output: /foo/caller.cjs
+  console.log(callSite1.getFileName()) // Output: file:///foo/callee.mjs
+  console.log(callSite2.getFileName()) // Output: file:///foo/caller.mjs
 
   console.log(callSite1.getFunctionName()) // Output: callee
   console.log(callSite2.getFunctionName()) // Output: caller
@@ -160,8 +172,8 @@ const callee = () => {
   console.log(callerSite1.getFileName() === callSite1.getFileName()) // Output: true
   console.log(callerSite2.getFileName() === callSite2.getFileName()) // Output: true
 
-  console.log(callerSite1.getFileName()) // Output: /foo/callee.cjs
-  console.log(callerSite2.getFileName()) // Output: /foo/caller.cjs
+  console.log(callerSite1.getFileName()) // Output: file:///foo/callee.mjs
+  console.log(callerSite2.getFileName()) // Output: file:///foo/caller.mjs
 
   console.log(callerSite1.getFunctionName() === callSite1.getFunctionName()) // Output: true
   console.log(callerSite2.getFunctionName() === callSite2.getFunctionName()) // Output: true
@@ -173,8 +185,8 @@ const callee = () => {
   const filePath1 = extractFilePath(callerSite1)
   const filePath2 = extractFilePath(callerSite2)
 
-  console.log(filePath1) // Output: /foo/callee.cjs
-  console.log(filePath2) // Output: /foo/caller.cjs
+  console.log(filePath1) // Output: /foo/callee.mjs
+  console.log(filePath2) // Output: /foo/caller.mjs
 
   // `getCallerFile`:
   const callerFile1 = getCallerFile()
@@ -183,8 +195,8 @@ const callee = () => {
   console.log(callerFile1 === filePath1) // Output: true
   console.log(callerFile2 === filePath2) // Output: true
 
-  console.log(callerFile1) // Output: /foo/callee.cjs
-  console.log(callerFile2) // Output: /foo/caller.cjs
+  console.log(callerFile1) // Output: /foo/callee.mjs
+  console.log(callerFile2) // Output: /foo/caller.mjs
 
   // `getCallerDir`:
   const callerDir1 = getCallerDir()
@@ -197,36 +209,36 @@ const callee = () => {
   console.log(callerDir2) // Output: /foo
 }
 
-module.exports = callee
+export default callee
 ```
 
-`/foo/caller.cjs`
+`/foo/caller.mjs`
 ```javascript
-const callee = require('./callee.cjs')
+import callee from './callee.mjs'
 const caller = () => callee()
 caller()
 ```
 
-### ES Modules
-`/foo/callee.mjs`
+### CommonJS
+`/foo/callee.cjs`
 ```javascript
-import { dirname } from 'node:path'
+const { dirname } = require('node:path')
 
-import {
+const {
   stackTrace,
   getCallerSite,
   extractFilePath,
   getCallerFile,
   getCallerDir
-} from '@mnrendra/stack-trace'
+} = require('@mnrendra/stack-trace')
 
 const callee = () => {
   // `stackTrace`:
   const [callSite1] = stackTrace()
   const [callSite2] = stackTrace(callee, { limit: 1 }) // Pass the `callee` function as the callee.
 
-  console.log(callSite1.getFileName()) // Output: file:///foo/callee.mjs
-  console.log(callSite2.getFileName()) // Output: file:///foo/caller.mjs
+  console.log(callSite1.getFileName()) // Output: /foo/callee.cjs
+  console.log(callSite2.getFileName()) // Output: /foo/caller.cjs
 
   console.log(callSite1.getFunctionName()) // Output: callee
   console.log(callSite2.getFunctionName()) // Output: caller
@@ -238,8 +250,8 @@ const callee = () => {
   console.log(callerSite1.getFileName() === callSite1.getFileName()) // Output: true
   console.log(callerSite2.getFileName() === callSite2.getFileName()) // Output: true
 
-  console.log(callerSite1.getFileName()) // Output: file:///foo/callee.mjs
-  console.log(callerSite2.getFileName()) // Output: file:///foo/caller.mjs
+  console.log(callerSite1.getFileName()) // Output: /foo/callee.cjs
+  console.log(callerSite2.getFileName()) // Output: /foo/caller.cjs
 
   console.log(callerSite1.getFunctionName() === callSite1.getFunctionName()) // Output: true
   console.log(callerSite2.getFunctionName() === callSite2.getFunctionName()) // Output: true
@@ -251,8 +263,8 @@ const callee = () => {
   const filePath1 = extractFilePath(callerSite1)
   const filePath2 = extractFilePath(callerSite2)
 
-  console.log(filePath1) // Output: /foo/callee.mjs
-  console.log(filePath2) // Output: /foo/caller.mjs
+  console.log(filePath1) // Output: /foo/callee.cjs
+  console.log(filePath2) // Output: /foo/caller.cjs
 
   // `getCallerFile`:
   const callerFile1 = getCallerFile()
@@ -261,8 +273,8 @@ const callee = () => {
   console.log(callerFile1 === filePath1) // Output: true
   console.log(callerFile2 === filePath2) // Output: true
 
-  console.log(callerFile1) // Output: /foo/callee.mjs
-  console.log(callerFile2) // Output: /foo/caller.mjs
+  console.log(callerFile1) // Output: /foo/callee.cjs
+  console.log(callerFile2) // Output: /foo/caller.cjs
 
   // `getCallerDir`:
   const callerDir1 = getCallerDir()
@@ -275,12 +287,12 @@ const callee = () => {
   console.log(callerDir2) // Output: /foo
 }
 
-export default callee
+module.exports = callee
 ```
 
-`/foo/caller.mjs`
+`/foo/caller.cjs`
 ```javascript
-import callee from './callee.mjs'
+const callee = require('./callee.cjs')
 const caller = () => callee()
 caller()
 ```