# pkg-to-readme

> Generate README.md from package.json

Latest version **3.0.1** (published 2024-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install pkg-to-readme
pnpm add pkg-to-readme
yarn add pkg-to-readme
bun add pkg-to-readme
```

Provides the command `pkg-to-readme`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2024-08-18 |
| First published | 2016-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | azu |
| Maintainers | azu |

## Links

- npm: https://www.npmjs.com/package/pkg-to-readme
- Repository: https://github.com/azu/pkg-to-readme
- Issues: https://github.com/azu/pkg-to-readme/issues
- npm.io page: https://npm.io/package/pkg-to-readme

## Dependencies (3)

- [ejs](https://npm.io/package/ejs.md) ^3.1.10
- [meow](https://npm.io/package/meow.md) ^13.2.0
- [read-package-up](https://npm.io/package/read-package-up.md) ^11.0.0

## Recent versions

- 3.0.1 (latest) — 2024-08-18
- 3.0.0 — 2024-02-03
- 2.0.0 — 2023-07-11
- 1.1.2 — 2022-04-09
- 1.1.1 — 2022-02-22
- 1.1.0 — 2016-11-06
- 1.0.4 — 2016-05-04
- 1.0.3 — 2016-05-04
- 1.0.2 — 2016-05-04

## README

# pkg-to-readme

Generate README.md using package.json from command line.

## Install

Install with [npm](https://www.npmjs.com/)

```sh
$ npm install pkg-to-readme -g
```

## Usage

### from Command line

```
$ pkg-to-readme

Options
-t, --template  Path to template file. default: ~/.readme-genrc
-o, --output    Path to output. default: ./README.md 
-f, --force     Force update

```

Example:

```
$ pkg-to-readme --template path/to/template.md --output path/to/README.md
```

### from Node.js

pkg-to-readme is a pure esm module.

```js
import { pkg2readme } from "pkg-to-readme";
readmeGen({
    cwd: __dirname,
    output: outputPath,
    template: path.join(__dirname, "./fixture/README.ejs")
}).then(() => {
    // ok
});
```

## Running tests

Install dev dependencies:

```sh
$ npm test
```

## License

MIT © azu

## Thanks

Base on [akameco/readme-gen: README generator for node.js.](https://github.com/akameco/readme-gen "akameco/readme-gen: README generator for node.js.")

@[akameco](https://github.com/akameco "akameco")

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