Readme Generator

Generate a detail and organized README.md file for your project using the command line with just simple prompt.

Prerequisites

• Install node and npm

sudo apt install nodejs
or
sudo apt install node

• Get your openai api key

Get Key

Usage

• Install the package globally

npm install -g @ayobami6/readme-generate

• Export your openai api key as an environment variable

export OPENAI_API_KEY=your_api_key

• Run the command

readme-generate

• Answer the prompt and your README.md file will be generated in the current directory.

demo.mp4

Development Setup

• Clone the repository

git clone <url>

• cd into the project directory

cd readme-generate

• Install dependencies

npm install or make install

• Run the script

node index.js or make run

Contributing

Contributions, issues and feature requests are welcome! feel free to check issues page

Show your support

If you find this project useful, please give it a ⭐️!

📝 License

This project is MIT licensed.