diff --git a/packages/hooks/README.md b/packages/hooks/README.md index 4323cbf..9d94466 100644 --- a/packages/hooks/README.md +++ b/packages/hooks/README.md @@ -1,17 +1,31 @@ # Hooks [](https://github.com/feathersjs/hooks/actions?query=workflow%3A%22Node+CI%22) -[](https://david-dm.org/feathersjs/feathers?path=packages/hooks) +[](https://github.com/feathersjs/hooks/actions/workflows/deno.yml) [](https://www.npmjs.com/package/@feathersjs/hooks) -`@feathersjs/hooks` brings Koa style middleware to any asynchronous JavaScript function. +`@feathersjs/hooks` brings Koa style middleware to any asynchronous JavaScript and TypeScript function or class. ## Installation +### Node + ``` npm install @feathersjs/hooks --save ``` +```js +const { hooks } = require('@feathersjs/hooks'); + +import { hooks } from '@feathersjs/hooks'; +``` + +### Deno + +```js +import { hooks } from 'https://deno.land/x/hooks@x.x.x/deno/index.ts'; +``` + ## Documentation See [feathersjs/hooks](https://github.com/feathersjs/hooks/) for the complete documentation.