easy-readme

easy-readme

generate readme file for your next project with a lot of options

Features

• 6 badges are includeds
• install ,usage and API headers and npm version , licence badges are generated with default options

Install

npm install easy-readme --save-dev

Usage

const readme = require("easy-readme");

  // generate readme file with default options
  readme(); 

  // with options contents align to center and cli header included
  readme({align:'center',contents:{cli:true}})

Note

you must have a package.json and git repository in the current directory in order to generate readme.md file

cli

$ easyreadme --help

  generate readme file for your next project with a lot of options

  Usage

  $ easyreadme <options> …

  Options

  --center, -c   align the markdown in center
  --cli,    -i   include cli header header
  --exp,    -e   include example header header
  --dep,    -p   add dependency badge
  --build,  -b   add build status badge
  --cov,    -v   add coverage badge
  --down,   -d   add coverage badge


  Examples

  $ easyreadme
  √ readme.md created successfully !

  $ easyreadme --center --build
  √ readme.md created successfully !

API

easy-readme(options)

string

Type: string

given name.

options

Type: object

chooser what you would to include in your readme file.

default options :

{
  align: 'left',
  npm: true,
  licence: true,
  api: true,
  badges: {
    dependancy: false,
    build: false,
    cov: false,
    download: false
  },
  contents: {
    cli: false,
    example: false
  }
}

align

Type: string
Default: left

specify how to align of the content left,center.

npm

Type: boolean
Default: true

allow npm version badge to be generated in the file

licence

Type: boolean
Default: true

allow licence badge to be generated in the file

api

Type: boolean
Default: true

allow api header to be generated in the file

badges

Type: object

choose the badges to include in the file

	 badges:{
             dependancy: false,
             build: false,
             cov: false,
             download: false
	 }

contents

Type: object

choose the headers to include in the file

	 contents:{
             cli: false,
             example: false,
	 }

License

MIT © abdelhak akermi