Introduction
Welcome to readmit!
What is readmit?
Readmit is a simple CLI tool to generate beautiful READMEs, DOCS or guides for your projects.
Readmit is proudly built with Go.
Instructions
Installation
Get started with readmit using our quick start installation guide to get your project started.
Commands
Commands
Commands that saaves you hours.
Support
Bugs and Suggestions
Contact the dev for any suggestions on readmit.
How to Use This Documentation
This documentation is designed to guide you through everything you need to know about using readmit. Here’s how to get started:
- Getting Started: Learn how to install supametrics for the first time.
- Features: Explore detailed guides on each feature.
Prerequisites
Before using readmit, ensure you have the following:
- Go installed (https://go.dev).
- Basic understanding of using CLIs.
Key Features
Readmit offers a wide range of features to empower your analytics journey:
| Feature | Description |
|---|---|
| Readme generating | Generates a README.md file in the current directory. |
| CONTRIBUTION.md generating | Generates a CONTRIBUTING.md file in the current directory. |
| App Documentation | Generates comprehensive app and API docs in a folder or single file. |
| Commit messages | Generates a commit message (optimized: only sends diffs). |
| Vulnerability Report | Generates a REPORT.md file containing all codebase vulnerabilities with fixes. |
| .gitignore Support | Respects project .gitignore rules and safely skips ignored files. |
| Smart Push | One command to stage, AI-generate commit, commit, and push. |
| Command Suggestions | Automatically suggests the closest valid command if you mistype. |
Follow me on social media to be the first to know when a new feature or bug is fixed