Skip to content

Commit

Permalink
docs: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mtorre4580 committed Dec 17, 2023
1 parent 0bbd756 commit ac1bbba
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A utility library designed to notify about deprecated functions or methods within objects.

![Logo](https://github.com/mtorre4580/is-deprecated/blob/main/deprecated.png?raw=true)

## Installation

```
Expand Down Expand Up @@ -79,7 +81,7 @@ const users = await APIWithDeprecated.getUsers();

## Best Practices

- To building time use the decorator `@deprecated` to notify that the method is deprecated in the docs
- To building time use the jsdoc decorator [@deprecated](https://jsdoc.app/tags-deprecated) in the code
- To runtime use the function from this lib `deprecated` to notify in the console
- The sendMetrics function allows to get more insight what app / micro frontend / api is using the deprecated lib to notify
- The sendMetrics function allows to get more insight what app,frontend or api is using the deprecated lib to notify
- You can use any env variable to apply the wrapper or not to avoid validation only for development, staging environment
Binary file modified deprecated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ac1bbba

Please sign in to comment.