Setup

Using readmit is straightforward.

Usage

The readmit CLI provides a generate command to create various types of documentation files.

readmit generate [type]

Available type options:

• readme: Generates a README.md file in the current directory.
• contribution: Generates a CONTRIBUTING.md file in the current directory.
• commit: Generates a commit message and prints it to the console (based on your Git diff).
• dockerfile: Generates an optimized Dockerfile for your project.

Examples:

Generate a README.md file:

readmit generate readme

Generate a CONTRIBUTING.md file:

readmit generate contribution

Generate a commit message:

readmit generate commit

Generate a Dockerfile:

readmit generate dockerfile

Generate a REPORT.md file (Check for vulnerabilities):

readmit watchtower

Now Enjoy