Skip to content

Commit

Permalink
Readme tweaks
Browse files Browse the repository at this point in the history
It no longer strips the BOM, see: sindresorhus/read-pkg@0cd09a0

Fixes #14
  • Loading branch information
sindresorhus committed Dec 6, 2019
1 parent 69983fc commit d96ce60
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Read the closest package.json file",
"license": "MIT",
"repository": "sindresorhus/read-pkg-up",
"funding": "https://github.com/sponsors/sindresorhus",
"author": {
"name": "Sindre Sorhus",
"email": "[email protected]",
Expand Down
11 changes: 2 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,19 @@

> Read the closest package.json file

## Why

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


## Install

```
$ npm install read-pkg-up
```


## Usage

```js
Expand All @@ -39,7 +35,6 @@ const readPkgUp = require('read-pkg-up');
})();
```


## API

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

##### cwd

Type: `string`<br>
Type: `string`\
Default: `process.cwd()`

Directory to start looking for a package.json file.

##### normalize

Type: `boolean`<br>
Type: `boolean`\
Default: `true`

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


## read-pkg-up for enterprise

Available as part of the Tidelift Subscription.

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)


## Related

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

0 comments on commit d96ce60

Please sign in to comment.