Doc Autobot Website

Note: This README was generated by doc-autobot 🤖

This is the official promotional website for Doc Autobot, the AI-powered CLI tool that automatically generates README.md and CONTRIBUTING.md files for any project. This website is designed to showcase the features, demonstrate the usage, and provide essential information about the tool.

Note: This README was generated by doc-autobot 🤖

This is the official promotional website for Doc Autobot, the AI-powered CLI tool that automatically generates README.md and CONTRIBUTING.md files for any project. This website is designed to showcase the features, demonstrate the usage, and provide essential information about the tool.

Key Features

Table of Contents

• Features and functionalities
• How It Works (Demo)
• Environment Variables
• Contact

Features and functionalities

• AI-Powered README.md Generation: Automatically creates a detailed README.md by analyzing your project's content.
• Templated CONTRIBUTING.md Generation: Quickly generates a standard CONTRIBUTING.md file.
• Interactive Wizard: A user-friendly wizard guides you through the options if you run the tool without commands.
• Multiple Commands: Offers dedicated commands for generating specific files (readme, contributing).
• Project Context Awareness: Fetches details from package.json to inform documentation generation.
• Tech Stack Agnostic: Useful for any type of project, regardless of the technology stack.

How It Works (Demo)

Here are the four simple steps to get professional documentation for your project using the doc-autobot CLI tool:

1. Install the tool Get started with a simple npm install command.

   $ npm install -g doc-autobot

2. Setup Gemini API key Configure your Google Gemini API key for AI-powered generation.

   $ echo 'GEMINI_API_KEY=your_api_key' > .env

3. Run the command Generate your README with one simple command.

   $ doc-autobot readme

4. Get your document Your comprehensive README is ready to use!

   ✅ README.md generated successfully!

Configuration

To enable the AI-powered features of the doc-autobot CLI tool, you need to configure your Google Gemini API key.

1. Obtain your API key from Google AI Studio.

2. Create a .env file in the root of the project where you intend to run the CLI tool.

3. Add your API key to the .env file as follows:

   GEMINI_API_KEY=YOUR_GEMINI_API_KEY
   

To enable AI-powered README.md generation, you must provide a Google Gemini API key.

1. Obtain your key from Google AI Studio.
2. Create a .env file in the directory where you run the doc-autobot command.
3. Add your API key to the .env file:

GEMINI_API_KEY=YOUR_GEMINI_API_KEY_HERE

Contact

Hemant Patel

• GitHub: @hemantpatel011
• LinkedIn: Hemant Patel

Here are the four simple steps to get professional documentation for your project using the doc-autobot CLI tool:

1. Install the tool Get started with a simple npm install command.

   $ npm install -g doc-autobot

2. Setup Gemini API key Configure your Google Gemini API key for AI-powered generation.
   

   Create a .env file in the root of your project.

   $ echo 'GEMINI_API_KEY=your_api_key' > .env

   Replace your_api_key with your actual Gemini API key. Obtain your key from Google AI Studio.

3. Run the command Generate your README with one simple command.

   $ doc-autobot readme

4. Get your document Your comprehensive README is ready to use!

   ✅ README.md generated successfully!

Contributing

We welcome contributions from the community! If you have an idea for a new feature or have found a bug, please open an issue on our GitHub repository.

License

Doc Autobot is licensed under the MIT License. See the LICENSE file for more information.

Contact

Hemant Patel

• GitHub: @hemantpatel011
• LinkedIn: Hemant Patel

<br