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).
• docs: Generates comprehensive app and API documentation.
• 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 Comprehensive Docs (Folder):

readmit generate docs

Generate Comprehensive Docs (Single File):

readmit generate docs --single-file

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

readmit watchtower

Smart Sync (Stage, Commit, Push):

readmit push
# This will: git add . -> AI generate commit msg -> git commit -> git push

Push to a specific branch:

readmit push [branch-name]

Now Enjoy