https://github.com/Nurullah-Nergiz/docify-cli

The CLI Readme Generator Tool is a powerful command-line utility that swiftly documents your GitHub projects by automating README file creation.
https://github.com/Nurullah-Nergiz/docify-cli

code-documentation developertools docify docify-cli documentation generator markdown readme

Last synced: 6 months ago
JSON representation

The CLI Readme Generator Tool is a powerful command-line utility that swiftly documents your GitHub projects by automating README file creation.

• Host: GitHub
• URL: https://github.com/Nurullah-Nergiz/docify-cli
• Owner: Nurullah-Nergiz
• License: mit
• Created: 2023-09-10T09:11:01.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-24T20:04:17.000Z (over 1 year ago)
• Last Synced: 2024-08-25T18:37:10.964Z (over 1 year ago)
• Topics: code-documentation, developertools, docify, docify-cli, documentation, generator, markdown, readme
• Language: JavaScript
• Homepage: https://nurullahnergiz.com/projects/docify/master
• Size: 578 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# docify-cli

The Docify CLI README Generator is a powerful command-line tool meticulously designed to simplify the creation and maintenance of high-quality README files for your software projects. Crafting a comprehensive README is crucial for effectively conveying information about your project to potential users and contributors. With the Docify CLI README Generator, you can effortlessly streamline the README creation process, ensuring your projects boast professional and informative documentation. Dive into the world of seamless documentation with the Docify CLI README Generator, making project management and communication a breeze.

---

## Download

```bash

npx docify-cli

```

![media/1706008202546.gif](media/1706008202546.gif)

media/1706008202546.gif

Recommended NodeJS Version [v21.2.0](https://nodejs.org/dist/v21.2.0)

## Dependencies

 	axios: ^1.6.5,

	chalk: ^5.3.0,

	cli-table: ^0.3.11,

	conf: ^12.0.0,

	glob: ^11.0.0,

	ora: ^7.0.1,

	pnpm: ^8.14.2,

	prompts: ^2.4.2,

	semver: ^7.5.4,

	yargs: ^17.7.2,

	

## Dependencies

 	@types/node: ^20.6.0,

	@types/prompts: ^2.4.9,

	

---

## Author

 - Nurullah Nergiz

- [![website https://nurullahnergiz.com/](https://img.shields.io/badge/-transparent?style=social&logo=website&logoColor=%2523FF0000&label=https://nurullahnergiz.com/&labelColor=000000&color=000000&link=https://nurullahnergiz.com/)](https://nurullahnergiz.com/)

- [![github Nurullah-Nergiz](https://img.shields.io/badge/-transparent?style=social&logo=github&logoColor=%2523FF0000&label=Nurullah-Nergiz&labelColor=000000&color=000000&link=https://github.com/Nurullah-Nergiz)](https://github.com/Nurullah-Nergiz)

- [![x nurullahNergiz_](https://img.shields.io/badge/-transparent?style=social&logo=x&logoColor=%2523FF0000&label=nurullahNergiz_&labelColor=000000&color=000000&link=https://x.com/nurullahNergiz_)](https://x.com/nurullahNergiz_)

- [![linkedin nurullah-nergiz/](https://img.shields.io/badge/-transparent?style=social&logo=linkedin&logoColor=%2523FF0000&label=nurullah-nergiz/&labelColor=000000&color=000000&link=https://linkedin.com/in/nurullah-nergiz/)](https://linkedin.com/in/nurullah-nergiz/)

- [![medium nurullahnergiz](https://img.shields.io/badge/-transparent?style=social&logo=medium&logoColor=%2523FF0000&label=nurullahnergiz&labelColor=000000&color=000000&link=https://medium.com/@nurullahnergiz)](https://medium.com/@nurullahnergiz)

- [![youtube nurullah-nergiz](https://img.shields.io/badge/-transparent?style=social&logo=youtube&logoColor=%2523FF0000&label=nurullah-nergiz&labelColor=000000&color=000000&link=https://youtube.com/@nurullah-nergiz)](https://youtube.com/@nurullah-nergiz)

---

## License

 docify-cli is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

This project was generated with [Docify-Cli](https://www.npmjs.com/package/docify-cli).