Skip to content

Commit f2af63a

Browse files
authored
Tweaks for v5 release (#560)
1 parent 2dca965 commit f2af63a

File tree

4 files changed

+58
-195
lines changed

4 files changed

+58
-195
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 113 deletions
This file was deleted.

README.md

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,43 +7,20 @@
77
[![Download Status](https://img.shields.io/npm/dm/feathers.svg?style=flat-square)](https://www.npmjs.com/package/feathers-hooks-common)
88
[![Slack Status](http://slack.feathersjs.com/badge.svg)](http://slack.feathersjs.com)
99

10-
> Useful hooks for use with Feathers services.
10+
A collection of useful hooks to use with Feathers services.
1111

12-
---
13-
14-
> Use feathers-hooks-common v3.10.0 with FeathersJS v2 (Auk).
15-
16-
> Use feathers-hooks-common v4.x.x with FeathersJS v3 (Buzzard).
17-
18-
## Migration to v4 (for FeathersJS v3 Buzzard) from v3 (for FeathersJSv2 Auk).
19-
20-
- Docs moved to [feathers-plus web site](https://feathers-plus.github.io/v1/feathers-hooks-common/guide.html).
21-
22-
- v4.x.x now supports FeathersJS v3 (Buzzard). Continue using v3.10.0 for FeathersJS v2 (Auk).
23-
- Removed:
24-
- Removed support for the deprecated legacy syntax in `populate`.
25-
- Removed the deprecated `remove` hook in favor of `discard`.
26-
27-
- Deprecated. These will be removed in FeathersJS v3 (Crow).
28-
- Deprecated `pluck` in favor of `iff(isProvider('external'),` `keep(...fieldNames))`. **Be careful!**
29-
- Deprecated the `client` in favor of the `paramsFromClient`.
30-
31-
- Added modules. They work with both FeathersJS v2 and v3.
32-
- `fastJoin` hook - Very fast alternative to `populate`.
33-
- `makeCallingParams` utility - Help construct `context.params` when calling services.
12+
```
13+
npm install feathers-hooks-common --save
14+
```
3415

3516
## Documentation
3617

37-
Refer to [Feathers-Plus web site](https://feathers-plus.github.io/v1/feathers-hooks-common/guide.html).
38-
39-
## Installation
40-
41-
Run `npm install feathers-hooks-common --save` in your project folder (installs the latest v4 release).
18+
For the full list and API of available hooks and utilities, refer to the [feathers-hooks-common documentation](https://hooks-common.feathersjs.com/overview.html).
4219

4320
## Tests
4421

4522
`npm test` to run tests.
4623

4724
## License
4825

49-
See LICENSE.
26+
See [LICENSE](LICENSE).

package.json

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"release:patch": "npm version patch && npm publish",
1616
"release:minor": "npm version minor && npm publish",
1717
"release:major": "npm version major && npm publish",
18-
"changelog": "github_changelog_generator && git add CHANGELOG.md && git commit -am \"Updating changelog\"",
18+
"changelog": "github_changelog_generator --max-issues 200 && git add CHANGELOG.md && git commit -am \"Updating changelog\"",
1919
"lint": "semistandard --fix",
2020
"lint:types": "dtslint types",
2121
"mocha": "mocha --opts mocha.opts",
@@ -42,8 +42,7 @@
4242
],
4343
"author": {
4444
"name": "John J. Szwaronek",
45-
"email": "[email protected]",
46-
"url": "https://feathers-plus.github.io"
45+
"email": "[email protected]"
4746
},
4847
"license": "MIT",
4948
"bugs": {
@@ -91,6 +90,6 @@
9190
"vuepress-theme-default-prefers-color-scheme": "^1.0.3"
9291
},
9392
"engines": {
94-
"node": ">= 6"
93+
"node": ">= 10"
9594
}
9695
}

0 commit comments

Comments
 (0)