# readme-plus

> A readme file generator

Latest version **1.0.0** (published 2015-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install readme-plus
pnpm add readme-plus
yarn add readme-plus
bun add readme-plus
```

Provides the command `readme`.

## 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.0.0 |
| Published | 2015-04-14 |
| First published | 2015-04-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+7 in 3 direct dependencies) |
| Install scripts | no |
| Author | Mathew Foscarini |
| Maintainers | Mathew Foscarini |
| Keywords | readme, generator, command line |

## Links

- npm: https://www.npmjs.com/package/readme-plus
- Repository: http://github.com/thinkingmedia/readme
- Homepage: https://github.com/thinkingmedia/readme
- Issues: https://github.com/thinkingmedia/readme/issues
- npm.io page: https://npm.io/package/readme-plus

## Dependencies (8)

- [q](https://npm.io/package/q.md) ~1.2.0
- [optjs](https://npm.io/package/optjs.md) ^3.2.1-boom
- [lodash](https://npm.io/package/lodash.md) ~3.0.0
- [fileset](https://npm.io/package/fileset.md) ^0.1.5
- [shelljs](https://npm.io/package/shelljs.md) ^0.3.0
- [winston](https://npm.io/package/winston.md) ^0.9.0
- [sprintf-js](https://npm.io/package/sprintf-js.md) ^1.0.2
- [dustjs-linkedin](https://npm.io/package/dustjs-linkedin.md) ~2.6.0

## Recent versions

- 1.0.0 (latest) — 2015-04-14

## README

# readme [![Build Status](https://travis-ci.org/thinkingmedia/readme.svg?branch=master)](https://travis-ci.org/thinkingmedia/readme) [![Core Climate](https://codeclimate.com/github/thinkingmedia/readme/badges/gpa.svg)](https://codeclimate.com/github/thinkingmedia/readme)

A readme file generator

## null 


Readme+ uses the contents of the current work folder to generate a `README.md` file for the project. Most of your
time is spent in the source code and this is where you can add notes to be included in the output `README.md`.

Readme+ searches for `@readme` markers in the source code comments.

This is a test.


## Usage 


Run readme on the command line in the working folder where you want to generate a README.md file.

```shell
$ cd /home/user/work
$ readme
```

The default options assume your working folder contains a sub-folder named `src` that contains the source code for your project.

```
Usage: readme [options] <path>

Example: readme --source=./www/js /home/mathew/thinkingmedia/readme

Options:
-v, --version    print version number
-s, --silent     hides copyright message
-d, --debug      send README.md output to console
--verbose        show debug message
--source         path to source folder (default: ./src)
--file           name of output file (default: README.md)
```


## Naming The Sections 


Each heading in a readme file is defined by a section of source code comments that use the `@readme` indicator. The
first word after the `@readme` indicator is the name and default title of the section.

```
/**
* @readme Install
*
*  Use `npm` to install the `foobar` module.
*
*  ```shell
*  $ npm install foobar
*  ```
*/
```

In the above example a heading labelled `Installations` will be added under the root section with the markdown text
found in the comment.


## Changing The Section Title 


You can customize the heading used for each section by providing title text after declaring the section.

```
/**
* @readme Install Installation Instructions
*
*  Use `npm` to install the `foobar` module.
*
*  ```shell
*  $ npm install foobar
*  ```
*/
```
In the above example the default heading `Install` is replaced with `Installation Instructions`.

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