# pkgd

> Get package publish info: package.json and file list.

Latest version **1.1.2** (published 2016-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install pkgd
pnpm add pkgd
yarn add pkgd
bun add pkgd
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2016-05-30 |
| First published | 2016-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Ivan Nikulin |
| Maintainers | inikulin |
| Keywords | publish, package, npm, files, package.json, size |

## Links

- npm: https://www.npmjs.com/package/pkgd
- Repository: https://github.com/inikulin/pkg-publish-info
- Homepage: https://github.com/inikulin/pkg-publish-info#readme
- Issues: https://github.com/inikulin/pkg-publish-info/issues
- npm.io page: https://npm.io/package/pkgd

## Dependencies (3)

- [fstream-npm](https://npm.io/package/fstream-npm.md) ^1.0.7
- [normalize-path](https://npm.io/package/normalize-path.md) ^2.0.1
- [pinkie-promise](https://npm.io/package/pinkie-promise.md) ^2.0.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2016-05-30
- 1.1.1 — 2016-05-18
- 1.1.0 — 2016-05-18
- 1.0.0 — 2016-02-01

## README

# pkgd
[![Build Status](https://api.travis-ci.org/inikulin/pkgd.svg)](https://travis-ci.org/inikulin/pkgd)

*Get package publish info: package.json and file list.*

There are some packages in npm already that read package files. However, some of them are broken and the
others are too slow. Moreover, this package reads `package.json` as well and provides nice Promise-based
interface.

## Install
```
npm install pkgd
```

## Usage
```js
const pkgd = require('pkgd');

pkgd('./projects/pkgd').then(info => {
    console.log(info.cfg.name);   // > "pkgd"
    console.log(info.cfg.author); // > "Ivan Nikulin (ifaaan@gmail.com)"
    console.log(info.files);      // > [ "package.json", "README.md", "LICENSE", "index.js" ]
});
```

## Author
[Ivan Nikulin](https://github.com/inikulin) (ifaaan@gmail.com)

---
_Source: https://npm.io/package/pkgd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._