Skip to content

Commit d96ce60

Browse files
committedDec 6, 2019
Readme tweaks
It no longer strips the BOM, see: sindresorhus/read-pkg@0cd09a0 Fixes #14
1 parent 69983fc commit d96ce60

File tree

2 files changed

+3
-9
lines changed

2 files changed

+3
-9
lines changed
 

‎package.json

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "Read the closest package.json file",
55
"license": "MIT",
66
"repository": "sindresorhus/read-pkg-up",
7+
"funding": "https://github.com/sponsors/sindresorhus",
78
"author": {
89
"name": "Sindre Sorhus",
910
"email": "sindresorhus@gmail.com",

‎readme.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,19 @@
22

33
> Read the closest package.json file
44
5-
65
## Why
76

87
- [Finds the closest package.json](https://github.com/sindresorhus/find-up)
98
- [Gracefully handles filesystem issues](https://github.com/isaacs/node-graceful-fs)
10-
- [Strips UTF-8 BOM](https://github.com/sindresorhus/strip-bom)
119
- [Throws more helpful JSON errors](https://github.com/sindresorhus/parse-json)
1210
- [Normalizes the data](https://github.com/npm/normalize-package-data#what-normalization-currently-entails)
1311

14-
1512
## Install
1613

1714
```
1815
$ npm install read-pkg-up
1916
```
2017

21-
2218
## Usage
2319

2420
```js
@@ -39,7 +35,6 @@ const readPkgUp = require('read-pkg-up');
3935
})();
4036
```
4137

42-
4338
## API
4439

4540
### readPkgUp(options?)
@@ -56,26 +51,24 @@ Type: `object`
5651

5752
##### cwd
5853

59-
Type: `string`<br>
54+
Type: `string`\
6055
Default: `process.cwd()`
6156

6257
Directory to start looking for a package.json file.
6358

6459
##### normalize
6560

66-
Type: `boolean`<br>
61+
Type: `boolean`\
6762
Default: `true`
6863

6964
[Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data.
7065

71-
7266
## read-pkg-up for enterprise
7367

7468
Available as part of the Tidelift Subscription.
7569

7670
The maintainers of read-pkg-up and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-read-pkg-up?utm_source=npm-read-pkg-up&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
7771

78-
7972
## Related
8073

8174
- [read-pkg](https://github.com/sindresorhus/read-pkg) - Read a package.json file

0 commit comments

Comments
 (0)
Please sign in to comment.