About 📖

Command line (CLI) program that generates a readme file for your project. The readme file contains instructions for your project. The program is built using NodeJs. You install it globally on your computer and run it at the location of your project. It will then create a Readme file

Key Features ✨

• Ready-made templates per project type (mobile, backend, frontend, other)
• Auto-detect project metadata from package.json, requirements.txt, pyproject.toml, go.mod, Cargo.toml and the git remote — offered as defaults
• Modern interactive TUI (arrow-key select, section multiselect, live preview)
• Non-interactive mode (--yes) for scripting and CI
• Generates shields.io badges for GitHub repositories
• Pick exactly which sections you want; the table of contents adapts
• Backs up an existing README.md instead of overwriting it
• Uses emoji in instructions and is easy to run with a short command

Technologies Used 🤖

• Node.js (>= 18)
• npm or yarn
• @clack/prompts — interactive TUI
• chalk, figlet, boxen — terminal styling

Getting Started 👨🏻‍💻

You can run the program via npm or by downloading this repository

Prerequisites

Before you begin, ensure you have met the following requirements:

• nodejs

• npm or yarn

Installation and Configuration 🎯

Follow these steps to get the project up and running on your local machine:

1. Clone the repository:

git clone https://github.com/qobulovasror/readme-generator.git

2. Navigate to the project directory:

cd "readme-generator"

3. Open code editor

npm i -g .

Installation using npm 🎯

1. Install package:

npm i -g @qobulovasror/mkrm

or

yarn global add @qobulovasror/mkrm

Using the program 🕹️

1. Go to the location of your project:

cd yourProject

2. Run the generator:

mkrm

Answer the prompts (or just press Enter to accept the auto-detected defaults), pick the sections you want, and your README.md is written.

Command-line options ⚙️

| Option | Description | | --- | --- | | mkrm | Run the interactive generator | | mkrm -y, --yes | Non-interactive: use auto-detected values + defaults | | mkrm -o <path>, --output <path> | Write to a custom path (default: ./README.md) | | mkrm -v, --version | Print the installed version | | mkrm -h, --help | Show help |

Examples:

# Generate without any questions, using detected metadata
mkrm --yes

# Write to a custom location
mkrm --output docs/README.md

💡 The project name, description, tech-stack, repository URL and license are auto-detected from your project files and offered as defaults — press Enter to accept them.

Contributing 🤝

We welcome contributions from the community to improve the project. To contribute, follow these steps:

1. Fork the repository: Click the "Fork" button in the upper-right corner of the repository's page on GitHub. This will create a copy of the repository in your GitHub account.

2. Clone the forked repository:

   git clone https://github.com/qobulovasror/readme-generator.git

3. Create a new branch:

   git checkout -b feature/new-feature

   Replace feature/new-feature with a descriptive branch name related to the feature or issue you're working on.

4. **Make your changes: **Implement your changes and ensure they follow the project's coding style and guidelines.

5. Commit your changes:

   git commit -m "Add new feature or fix issue"

6. Push your changes to GitHub:

   git push origin feature/new-feature

7. Create a Pull Request:Go to the GitHub page of your forked repository. Click on the "Compare & pull request" button next to your branch. Fill in the necessary details and submit the pull request.

8. Review and address feedback:Your pull request will be reviewed by the project maintainers. Address any feedback or comments provided during the review process.

9. **Merge your Pull Request:**Once your pull request has been approved and all checks pass, it will be merged into the main branch by a project maintainer.

Thank you for your contribution!

License 🧾

This project is licensed under the MIT License

You are free to:

• Use the code for personal or commercial purposes.
• Modify, distribute, and sublicense the code.

Under the following conditions:

• You must include the original copyright notice in all copies or substantial portions of the software.

This project is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software

Conclusion 🔚

Congratulations! You've reached the end of the README file for our project 😊. We hope this documentation has provided you with all the necessary information to understand, install, and contribute to the project effectively.

If you have any questions, feedback, or suggestions, please don't hesitate to reach out to us. Your input is valuable and helps us improve the project for everyone.

Thank you for your interest and support in our project. Happy coding! 🎉