readme-oz
v1.0.1
Published
A CLI tool that generates a well-structured README file for your projects.
Downloads
6
Maintainers
Readme
readme-generator
A CLI tool that generates a well-structured README file for your projects.
Installation
To install the package globally, run:
npm install -g readme-oz
Usage
To generate a README file, run:
readme-oz
Follow the prompts to choose a template and provide the necessary information. The generated README.md file will be saved in your current directory.
Templates
- Basic: Includes sections for project description and installation.
- Advanced: Includes additional sections like usage, contributing, tests, license, author, and acknowledgements.
License
This project is licensed under the MIT License.