Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ahmad Nassri committed Dec 19, 2022
1 parent 8511c42 commit 14f3f69
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Match files using the patterns the shell uses, like stars and stuff.

[![license][license-img]][license-url]
[![release][release-img]][release-url]
[![super linter][super-linter-img]][super-linter-url]
[![test][test-img]][test-url]
[![semantic][semantic-img]][semantic-url]

> ***Note**: This is just a [`Promise`][] wrapped version of [`glob`][]*
Expand All @@ -20,8 +18,8 @@ $ npm install glob-promise glob

[`glob`][] is set as a `peerDependency` in [`package.json`][]

- `npm` <= `2` will automatically install `peerDependencies` if they are not explicitly depended upon higher in the dependency tree.
- `npm` >= 3 will no longer automatically install `peerDependencies`.
- `npm` \<= `2` will automatically install `peerDependencies` if they are not explicitly depended upon higher in the dependency tree.
- `npm` \>= 3 will no longer automatically install `peerDependencies`.

You will need to manually add `glob` as a dependency to your project for `glob-promise` to work.

Expand Down Expand Up @@ -94,11 +92,5 @@ The option object will be directly passed to [glob][].
[release-url]: https://github.com/ahmadnassri/node-glob-promise/releases
[release-img]: https://badgen.net/github/release/ahmadnassri/node-glob-promise

[super-linter-url]: https://github.com/ahmadnassri/node-glob-promise/actions?query=workflow%3Asuper-linter
[super-linter-img]: https://github.com/ahmadnassri/node-glob-promise/workflows/super-linter/badge.svg

[test-url]: https://github.com/ahmadnassri/node-glob-promise/actions?query=workflow%3Atest
[test-img]: https://github.com/ahmadnassri/node-glob-promise/workflows/test/badge.svg

[semantic-url]: https://github.com/ahmadnassri/node-glob-promise/actions?query=workflow%3Arelease
[semantic-img]: https://badgen.net/badge/📦/semantically%20released/blue

0 comments on commit 14f3f69

Please sign in to comment.