Skip to content

Commit c87d5e4

Browse files
committed
chore: update readme
1 parent aa25812 commit c87d5e4

1 file changed

Lines changed: 5 additions & 10 deletions

File tree

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ A lightweight JavaScript debugging utility, forked from [debug](https://www.npmj
99
> [!NOTE]
1010
> obug v1 retains most of the compatibility with [debug](https://github.com/debug-js/debug), but drops support for older browsers and Node.js, making it a drop-in replacement.
1111
>
12-
> The upcoming v2 refactors some API imports and usage for better support of ESM and TypeScript, easier customization, and an even smaller package size.
12+
> obug v2 refactors some API imports and usage for better support of ESM and TypeScript, easier customization, and an even smaller package size.
1313
1414
## Key Differences from `debug`
1515

1616
- ✨ Minimal footprint
17+
- 7.7 kB package size
18+
- 1.4 KB minified + gzipped for browsers
1719
- 📦 Zero dependencies
1820
- 📝 Full TypeScript support
1921
- 🚀 Native ESM compatibility
@@ -29,23 +31,16 @@ npm install obug
2931

3032
## Usage
3133

32-
Please refer to the original [debug](https://github.com/debug-js/debug#usage) package for usage instructions.
33-
34-
## Refactor Plan
35-
36-
The obug package is currently a direct fork of the debug package with minimal modifications. The following refactor plan outlines the intended changes to be made in future releases.
37-
3834
```ts
3935
import { createDebug, disable, enable, enabled, namespaces } from 'obug'
4036

4137
// Get the currently enabled namespaces
4238
console.log(namespaces())
4339

44-
// createDebug has no extra properties or methods.
4540
const debug = createDebug('my-namespace', {
4641
// All options are optional
4742

48-
useColors: true, // false, true, 'auto'
43+
useColors: true, // false, true, undefined for auto-detect
4944
color: 2, // custom color
5045
// custom formatArgs
5146
formatArgs(args) {},
@@ -79,7 +74,7 @@ For more details, please refer to the [src/types-v2.ts](./src/types-v2.ts).
7974

8075
## Original Authors
8176

82-
As obug is a fork of debug, we would like to acknowledge the original authors:
77+
As obug is a fork of debug with significant modifications, we would like to acknowledge the original authors:
8378

8479
- TJ Holowaychuk
8580
- Nathan Rajlich

0 commit comments

Comments
 (0)