Awesome
Welcome to readme-kodyfire 👋
Generate readme.md for your project using Kodyfire cli
🏠 Homepage
Requirements
readme-kodyfire requires the kodyfire-cli to be installed
npm install -g kodyfire-cli
Install
npm install readme-kodyfire
Usage
Method 1: As a generator
In order to generate your artifacts, run the generate
command. The syntax is kody generate|g [kody] [concept]
. If you ommit kody
and concept
the assistant will prompt you to select them. As an example, run the following command from your terminal:
kody generate readme concept
Method 2: As a kody project
Refer to the kodyfire generate your artifact section. Once your project is initialized and ready for kody, run the following command to generate your README.
kody run -s kody-readme.json
📅 Future Features
- Create profile Readme (use [github-profile-readme-generator](rahuldkjain / github-profile-readme-generator))
- Create License
Run tests
TODO
Author
👤 Anis Marrouchi
- Website: https://noqta.tn
- Twitter: @anis_marrouchi
- GitHub: @anis-marrouchi
- LinkedIn: @marrouchi
🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Show your support
Give a ⭐️ if this project helped you!
Credits
readme-kodyfire builds on top of the original Readme generator readme-md-generator by kefranabg
📝 License
Copyright © 2022 Anis Marrouchi.
This project is MIT licensed.
This README was generated with ❤️ by readme-kodyfire