https://github.com/nooqta/readme-kodyfire
Generate readme.md for your project using Kodyfire cli
https://github.com/nooqta/readme-kodyfire
kody kodyfire readme-template
Last synced: 3 months ago
JSON representation
Generate readme.md for your project using Kodyfire cli
- Host: GitHub
- URL: https://github.com/nooqta/readme-kodyfire
- Owner: nooqta
- License: mit
- Created: 2022-07-13T13:21:15.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-20T18:22:48.000Z (about 2 years ago)
- Last Synced: 2025-01-18T12:47:21.772Z (5 months ago)
- Topics: kody, kodyfire, readme-template
- Language: TypeScript
- Homepage:
- Size: 236 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to readme-kodyfire 👋
[](https://github.com/nooqta/kodyfire#install-a-kody)
[](https://github.com/nooqta/kodyfire/blob/main/LICENSE)
[](https://twitter.com/anis\_marrouchi)
> Generate readme.md for your project using Kodyfire cli
### 🏠 [Homepage](https://github.com/nooqta/kodyfire)
## Requirements
readme-kodyfire requires the kodyfire-cli to be installed
```sh
npm install -g kodyfire-cli
```
## Install
```sh
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:
```sh
kody generate readme concept
```
### Method 2: As a kody project
Refer to the kodyfire __[generate your artifact](https://github.com/nooqta/kodyfire#generate-your-artifact)__ section.
Once your project is initialized and ready for kody, run the following command to generate your README.
```sh
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
```sh
TODO
```
## Author
👤 **Anis Marrouchi**
* Website: https://noqta.tn
* Twitter: [@anis\_marrouchi](https://twitter.com/anis\_marrouchi)
* GitHub: [@anis-marrouchi](https://github.com/anis-marrouchi)
* LinkedIn: [@marrouchi](https://linkedin.com/in/marrouchi)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/nooqta/readme-kodyfire/issues).
## Show your support
Give a ⭐️ if this project helped you!
## Credits
readme-kodyfire builds on top of the original Readme generator [readme-md-generator](https://github.com/kefranabg/readme-md-generator) by [kefranabg](https://github.com/kefranabg)
## 📝 License
Copyright © 2022 [Anis Marrouchi](https://github.com/anis-marrouchi).
This project is [MIT](https://github.com/nooqta/kodyfire/blob/main/LICENSE) licensed.
***
_This README was generated with ❤️ by [readme-kodyfire](https://github.com/nooqta/readme-kodyfire)_