emdaer

does a README.md

Scripts

lint – lint the codebase

npm run lint

start – generate the README for emdaer using emdaer

npm run start

CLI

You can install emdaer globally:

$ npm i -g emdaer
$ cd ~/your-project/
$ emdaer

Or you can save emdaer to specific projects:

$ cd ~/your-project
$ npm i -D emdaer
$ ./node_modules/.bin/emdaer

Either way, invoking emdaer requires the presence of a valid .emdaer.yml configuration file in the current directory.

Configuration

- title: true
- shields:
    style: 'flat-square'
    shields:
      - alt: Travis
        image: 'travis/flipactual/emdaer.svg'
        link: 'https://travis-ci.org/flipactual/emdaer/'
- text: 'does a README.md'
- include: './docs/bin.md'
- include: './docs/configuration.md'
- license: true

emdaer iterates over the array in .emdaer.yml and creates a README.md including the listed elements in the order they're provided.

.emdaer.yml supports the following field types:

title

type: boolean

If true, pulls title from the name field in the project's package.json and includes as a level one heading. If you'd like to use a different title, use text instead:

- text: '# My Title'

text

type: string

A string to insert into the README. Can include markdown formatting.

include

type: string

The path to a file to include in the README.

image

type: object

Details for an image to include in the README.

image.alt

type: array

Alt text for the image

image.link

type: string

An optional link to wrap the image.

image.path

type: string

The path to the image.

image.position

type: string

The alignment for the image ('left', 'center', 'right').

license

type: string

If true, pulls license and author information from package.json to include:

## License

<license> @ [<author.name>](<author.url>)

For any other formatting, use text or include.

contributors

type: boolean

If true, creates a table including the author and contributors from package.json. You must include the GitHub ID of each user:

  "author": {
    "name": "Flip",
    "url": "http://github.com/flipactual",
    "id": 1306968
  },

shields

type: object

Configuration and list of Shields to use.

shields.style

type: string

The style of shields to use. Supports plastic, flat, flat-square, or social.

shields.shields

type: array

A list of shields to include.

shields.shields[n].alt

type: string

The alt text for the Shield.

shields.shields[n].image

type: string

The path to the Shield image (eg travis/flipactual/emdaer.svg).

shields.shields[n].link

type: string

The link to open when clicking the Shield.

Contributors

Flip

License

MIT @ Flip