Prerequisites
- Install node and npm
sudo apt install nodejs
or
sudo apt install node- Get your openai api 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.
https://github.com/Ayobami6/readme-generate/assets/91608325/f559bcc6-0842-4b36-8750-4c13b8b804ea