This package has been deprecated

    Author message:

    Deprecated

    build-readme

    1.2.0 • Public • Published

    Build Readme

    Generate a Readme for your project with a simple CLI tool.

    Build Status Coverage Status NPM Licence

    What Can it Do?

    • Add a title
    • Add a description
    • Add an image
    • Add CI, License, Coverage, Package Version, and more badges
    • Choose an alignment (left or center)
    • Add sections such as "Install", "Usage", and "Development"
    • Name the README file

    Install

    Install the CLI tool globally:

    npm i -g build-readme

    Usage

    Run the following command and follow the prompts to generate a README file.

    build-readme

    Development

    Install project dependencies locally and run linting:

    # Install the project locally 
    npm i
     
    # Lint files 
    npx eslint index.js
     
    # Run tests 
    npm run test

    Install

    npm i build-readme

    DownloadsWeekly Downloads

    4

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    1.82 MB

    Total Files

    14

    Last publish

    Collaborators

    • avatar