Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
karmaniverous committed Oct 17, 2024
1 parent 817c9dd commit d7807b3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@

**_`controlledProxy` allows the behavior of any object to be modified & controlled non-destructively at runtime._**

The developer can:

- Alter the proxy's endpoint controls at runtime.

- Specify a context-aware handler for disabled endpoints, also at runtime.

- Create multiple proxies of an underlying object, each controlled differently.

- Inject proxies into dependent code & control them from the outside.

Easy use case:

- You have a utility library with extensive logging.

- You consume that library from an application that uses a custom logger like `winston`.

- You want your utility library also to log to `winston`.

- You normally want debug logging from the utility library disabled, _even when it is enabed in the outer application_, but you want to enable it selectively to help debug the outer app.

<!-- TYPEDOC_EXCLUDE -->

> [API Documentation](https://docs.karmanivero.us/controlled-proxy/)[CHANGELOG](https://github.com/karmaniverous/controlled-proxy/tree/main/CHANGELOG.md)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"bugs": {
"url": "https://github.com/karmaniverous/controlled-proxy/issues"
},
"description": "Allows the behavior of any object to be modified & controlled non-destructively at runtime.",
"description": "Control & modify the behavior of any object non-destructively at runtime.",
"devDependencies": {
"@dotenvx/dotenvx": "^1.19.3",
"@eslint/js": "^9.12.0",
Expand Down

0 comments on commit d7807b3

Please sign in to comment.