From 1929b691453c96732f300d9ec4bca875afadcfaa Mon Sep 17 00:00:00 2001 From: Julien Fontanet Date: Fri, 28 May 2021 12:06:45 +0200 Subject: [PATCH] chore(decorate-with): improve doc --- @vates/decorate-with/README.md | 4 +++- @vates/decorate-with/USAGE.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/@vates/decorate-with/README.md b/@vates/decorate-with/README.md index 9b1a072cb..861bfd3c5 100644 --- a/@vates/decorate-with/README.md +++ b/@vates/decorate-with/README.md @@ -16,7 +16,9 @@ Installation of the [npm package](https://npmjs.org/package/@vates/decorate-with ## Usage -For instance, allows using Lodash's functions as decorators: +### `decorateWith(fn, ...args)` + +Creates a new ([legacy](https://babeljs.io/docs/en/babel-plugin-syntax-decorators#legacy)) method decorator from a function decorator, for instance, allows using Lodash's functions as decorators: ```js import { decorateWith } from '@vates/decorate-with' diff --git a/@vates/decorate-with/USAGE.md b/@vates/decorate-with/USAGE.md index a9bf97c14..e304e636f 100644 --- a/@vates/decorate-with/USAGE.md +++ b/@vates/decorate-with/USAGE.md @@ -1,4 +1,6 @@ -For instance, allows using Lodash's functions as decorators: +### `decorateWith(fn, ...args)` + +Creates a new ([legacy](https://babeljs.io/docs/en/babel-plugin-syntax-decorators#legacy)) method decorator from a function decorator, for instance, allows using Lodash's functions as decorators: ```js import { decorateWith } from '@vates/decorate-with'