readmeg 1.0.0 → 1.0.1

package/README.md

@@ -5,27 +5,27 @@
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
 [![MIT License][license-shield]][license-url]
-[![LinkedIn][linkedin-shield]][linkedin-url]
+[![Twitter][twitter-shield]][twitter-url]
 
 <br />
 <div align="center">
-  <a href="https://github.com/your_username/readmeg">
-    <img src="https://images.unsplash.com/photo-1618401471353-b98aedd07871?q=80&w=120&auto=format&fit=crop" alt="Logo" width="80" height="80">
+  <a href="https://github.com/iamtyroon/readme-gen">
+    <img src="assets/logo.png" alt="Logo" width="80" height="80">
   </a>
 
-  <h3 align="center">readmeg</h3>
+<h3 align="center">readmeg</h3>
 
   <p align="center">
-    An AI-powered CLI tool to instantly generate beautiful, comprehensive, and professional README.md files for your repositories.
+    Zero-config terminal tool powered by Gemini that automatically generates comprehensive, production-grade README files for local repositories.
     <br />
-    <a href="https://github.com/your_username/readmeg"><strong>Explore the docs »</strong></a>
+    <a href="https://github.com/iamtyroon/readme-gen"><strong>Explore the docs »</strong></a>
     <br />
     <br />
-    <a href="https://github.com/your_username/readmeg">View Demo</a>
+    <a href="https://github.com/iamtyroon/readme-gen">View Demo</a>
     ·
-    <a href="https://github.com/your_username/readmeg/issues">Report Bug</a>
+    <a href="https://github.com/iamtyroon/readme-gen/issues">Report Bug</a>
     ·
-    <a href="https://github.com/your_username/readmeg/issues">Request Feature</a>
+    <a href="https://github.com/iamtyroon/readme-gen/issues">Request Feature</a>
   </p>
 </div>
 
@@ -56,27 +56,25 @@
 
 ## About The Project
 
-[![readmeg Screen Shot][product-screenshot]](https://github.com/your_username/readmeg)
+[![Product Name Screen Shot][product-screenshot]](https://github.com/iamtyroon/readme-gen)
 
-Writing a high-quality README is often the most tedious part of finishing a project. `readmeg` is an interactive Command Line Interface (CLI) tool designed to automate this process. By leveraging Google's advanced Gemini generative AI models, `readmeg` analyzes your project structure, prompts you for key details, and outputs a perfectly formatted, professional `README.md` file in seconds.
+Writing a comprehensive, high-quality README is often the most tedious part of finishing a project. `readmeg` solves this by automating the entire process. 
+
+By scanning your local repository structure, analyzing key manifest files (such as `package.json`, `tsconfig.json`, and `.env.example`), and leveraging the advanced contextual understanding of Google's Gemini AI, `readmeg` generates a production-grade, beautifully formatted README in seconds.
 
 Here's why you should use `readmeg`:
-* **Save Time**: Stop writing boilerplate markdown sections from scratch.
-* **Interactive Prompts**: Simple, step-by-step terminal questions guide you through defining your project's scope.
-* **AI-Powered**: Generates intelligent descriptions, installation steps, and usage guides based on your actual project configuration.
-* **Standardized Layouts**: Outputs clean markdown following industry-standard templates.
+* **Zero-Config**: No complex setup or configuration files required.
+* **Context-Aware**: It parses your actual codebase structure and dependencies to write accurate documentation.
+* **Interactive CLI**: Prompts you for key details to customize the output to your exact needs.
+* **Time-Saving**: Instantly generates standard sections like Installation, Usage, Roadmap, and License.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ### Built With
 
-This project is built using modern Node.js and TypeScript, leveraging powerful CLI and AI libraries:
-
 * [![Node.js][Node.js]][Node-url]
-* [![TypeScript][TypeScript]][TypeScript-url]
-* [![Google Gemini][Gemini]][Gemini-url]
-* [![Commander.js][Commander]][Commander-url]
-* [![Inquirer.js][Inquirer]][Inquirer-url]
+* [![Gemini][Gemini.js]][Gemini-url]
+* [![TypeScript][TypeScript.js]][TypeScript-url]
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -86,69 +84,66 @@ To get a local copy up and running, follow these simple steps.
 
 ### Prerequisites
 
-Ensure you have Node.js installed (version 18.0.0 or higher is recommended).
-
-* npm
-  ```sh
-  npm install npm@latest -g
-  ```
+* **Node.js** (v18.0.0 or higher recommended)
+* **Gemini API Key**: You will need an API key from Google AI Studio.
 
 ### Installation
 
-1. Get a free Gemini API Key from [Google AI Studio](https://aistudio.google.com/).
-2. Clone the repository:
+1. Clone the repository:
    ```sh
-   git clone https://github.com/your_username/readmeg.git
+   git clone https://github.com/iamtyroon/readme-gen.git
    ```
-3. Install NPM packages:
+2. Navigate to the project directory and install dependencies:
    ```sh
+   cd readme-gen
    npm install
    ```
-4. Create a `.env` file in the root directory and add your Gemini API key:
+3. Create a `.env` file in the root directory and add your Gemini API key:
    ```env
-   GEMINI_API_KEY=your_actual_api_key_here
+   GEMINI_API_KEY="YOUR_GEMINI_API_KEY"
    ```
-5. Build the TypeScript files (if modifying source files):
+4. Link the package globally to use the `readmeg` command anywhere:
    ```sh
-   npm run build
+   npm link
    ```
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Usage
 
-You can run `readmeg` directly using Node.js. The CLI will guide you through an interactive prompt session to gather information about your repository before generating the markdown file.
+Once installed globally, you can run `readmeg` in any local repository to generate its documentation.
 
-### Running the CLI
+### Run the Generator
 
-To start the interactive generation process:
+Navigate to the target repository where you want to generate a README and run:
 ```sh
-node ./bin/readmeg.js
+readmeg
 ```
 
-To view available CLI commands and options:
+### Command Line Options
+
+You can also view help and available options directly from the CLI:
 ```sh
-npm start
+readmeg --help
 ```
 
-### Example Interactive Flow
+### How It Works
 
-1. **Project Name**: Enter the name of your project (defaults to your directory name).
-2. **Description**: Provide a brief summary of what your application does.
-3. **Technologies**: Select or enter the main frameworks and languages used.
-4. **License**: Choose your project's license (e.g., MIT, Apache 2.0, GPL v3).
-5. **Output**: The tool will call the Gemini API and write a polished `README.md` directly to your root directory.
+1. **Codebase Scan**: `readmeg` analyzes your directory tree and identifies key configuration files.
+2. **Context Extraction**: It extracts metadata, dependencies, and scripts from files like `package.json` and `.env.example`.
+3. **AI Generation**: The extracted context is sent to the Gemini API to draft a structured, professional README.md.
+4. **Output**: The generated markdown is saved directly to your workspace as `README.md`.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Roadmap
 
-- [ ] Add support for automatic codebase parsing (reading `package.json`, `requirements.txt`, etc.)
-- [ ] Provide multiple pre-designed README templates (Minimal, Detailed, API-focused)
-- [ ] Add support for alternative LLM providers (OpenAI, Anthropic)
-- [ ] Implement a dry-run mode to preview markdown in the terminal before writing to disk
+- [ ] Support for additional language manifests (`Cargo.toml`, `pyproject.toml`, `go.mod`)
+- [ ] Custom template selection (e.g., Minimal, Academic, Enterprise)
+- [ ] Interactive terminal preview before writing to disk
+- [ ] GitHub Actions integration for automated documentation updates
 
-See the [open issues](https://github.com/your_username/readmeg/issues) for a full list of proposed features and known issues.
+See the [open issues](https://github.com/iamtyroon/readme-gen/issues) for a full list of proposed features and known issues.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -175,15 +170,15 @@ Distributed under the MIT License. See `LICENSE` for more information.
 
 ## Contact
 
-Your Name - [@your_twitter](https://twitter.com/your_twitter) - email@example.com
+iamtyroon - [@notyroon](https://x.com/notyroon)
 
-Project Link: [https://github.com/your_username/readmeg](https://github.com/your_username/readmeg)
+Project Link: [https://github.com/iamtyroon/readme-gen](https://github.com/iamtyroon/readme-gen)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Acknowledgments
 
-* [Google Gen AI SDK](https://github.com/google/generative-ai-js)
+* [Google Gemini AI SDK](https://github.com/google/generative-ai-js)
 * [Commander.js](https://github.com/tj/commander.js/)
 * [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/)
 * [Shields.io](https://shields.io)
@@ -191,27 +186,22 @@ Project Link: [https://github.com/your_username/readmeg](https://github.com/your
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-[contributors-shield]: https://img.shields.io/github/contributors/your_username/readmeg.svg?style=for-the-badge
-[contributors-url]: https://github.com/your_username/readmeg/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/your_username/readmeg.svg?style=for-the-badge
-[forks-url]: https://github.com/your_username/readmeg/network/members
-[stars-shield]: https://img.shields.io/github/stars/your_username/readmeg.svg?style=for-the-badge
-[stars-url]: https://github.com/your_username/readmeg/stargazers
-[issues-shield]: https://img.shields.io/github/issues/your_username/readmeg.svg?style=for-the-badge
-[issues-url]: https://github.com/your_username/readmeg/issues
-[license-shield]: https://img.shields.io/github/license/your_username/readmeg.svg?style=for-the-badge
-[license-url]: https://github.com/your_username/readmeg/blob/master/LICENSE.txt
-[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/your_username
-[product-screenshot]: https://images.unsplash.com/photo-1618401471353-b98aedd07871?q=80&w=600&auto=format&fit=crop
-
-[Node.js]: https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white
+[contributors-shield]: https://img.shields.io/github/contributors/iamtyroon/readme-gen.svg?style=for-the-badge
+[contributors-url]: https://github.com/iamtyroon/readme-gen/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/iamtyroon/readme-gen.svg?style=for-the-badge
+[forks-url]: https://github.com/iamtyroon/readme-gen/network/members
+[stars-shield]: https://img.shields.io/github/stars/iamtyroon/readme-gen.svg?style=for-the-badge
+[stars-url]: https://github.com/iamtyroon/readme-gen/stargazers
+[issues-shield]: https://img.shields.io/github/issues/iamtyroon/readme-gen.svg?style=for-the-badge
+[issues-url]: https://github.com/iamtyroon/readme-gen/issues
+[license-shield]: https://img.shields.io/github/license/iamtyroon/readme-gen.svg?style=for-the-badge
+[license-url]: https://github.com/iamtyroon/readme-gen/blob/main/LICENSE
+[twitter-shield]: https://img.shields.io/badge/-Twitter-black.svg?style=for-the-badge&logo=x&colorB=555
+[twitter-url]: https://x.com/notyroon
+[product-screenshot]: assets/readmeg_scrnshot.png
+[Node.js]: https://img.shields.io/badge/Node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white
 [Node-url]: https://nodejs.org/
-[TypeScript]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white
-[TypeScript-url]: https://www.typescriptlang.org/
-[Gemini]: https://img.shields.io/badge/Google%20Gemini-8E75C2?style=for-the-badge&logo=googlegemini&logoColor=white
-[Gemini-url]: https://deepmind.google/technologies/gemini/
-[Commander]: https://img.shields.io/badge/Commander.js-black?style=for-the-badge&logo=commander
-[Commander-url]: https://github.com/tj/commander.js/
-[Inquirer]: https://img.shields.io/badge/Inquirer.js-red?style=for-the-badge&logo=npm
-[Inquirer-url]: https://github.com/SBoudrias/Inquirer.js/
+[Gemini.js]: https://img.shields.io/badge/Gemini%20AI-8E75C2?style=for-the-badge&logo=googlegemini&logoColor=white
+[Gemini-url]: https://ai.google.dev/
+[TypeScript.js]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white
+[TypeScript-url]: https://www.typescriptlang.org/

package/bin/readmeg.js

@@ -11,6 +11,7 @@ import { Command } from "commander";
 import inquirer from "inquirer";
 import { GoogleGenAI } from "@google/genai";
 import dotenv from "dotenv";
+import { execSync } from "child_process";
 
 // Load local .env configurations if present
 dotenv.config();
@@ -20,10 +21,17 @@ const program = new Command();
 program
   .name("readmeg")
   .description("Automatically generate comprehensive production-grade README.md files for your local directory repositories using Gemini.")
-  .version("1.0.0")
+  .version("1.0.1")
   .option("-k, --api-key <key>", "Provide your Gemini API key manually")
   .option("-o, --output <file>", "Define custom output file path", "README.md")
   .option("-n, --non-interactive", "Run directly without interactive menu loop", false)
+  .option("-i, --include <files...>", "Explicitly include specific files or directories for scanning")
+  .option("-u, --github-user <username>", "Provide your GitHub username manually")
+  .option("-r, --repo-url <url>", "Provide your GitHub repository URL manually")
+  .option("-t, --twitter <url>", "Provide your Twitter Profile URL manually")
+  .option("-l, --linkedin <url>", "Provide your LinkedIn Profile URL manually")
+  .option("--logo <path>", "Path to the project logo image")
+  .option("--screenshot <path>", "Path to the project screenshot image")
   .parse(process.argv);
 
 const options = program.opts();
@@ -38,7 +46,6 @@ const IGNORED_DIRS = new Set([
   "venv",
   "env",
   ".aistudio",
-  "assets",
   ".next",
   ".svelte-kit",
   ".nuxt",
@@ -58,7 +65,24 @@ const MANIFEST_NAMES = new Set([
   "pom.xml",
   "build.gradle",
   "composer.json",
-  "setup.py"
+  "setup.py",
+  "tsconfig.json",
+  "jsconfig.json",
+  "vite.config.js",
+  "vite.config.ts",
+  "webpack.config.js",
+  "next.config.js",
+  "next.config.mjs",
+  "next.config.ts",
+  "nuxt.config.js",
+  "nuxt.config.ts",
+  "svelte.config.js",
+  "tailwind.config.js",
+  "tailwind.config.ts",
+  "Makefile",
+  "CMakeLists.txt",
+  ".env.example",
+  ".env.sample"
 ]);
 
 const SNIPPET_NAMES = new Set([
@@ -74,6 +98,181 @@ const SNIPPET_NAMES = new Set([
   "App.js"
 ]);
 
+const SOURCE_EXTENSIONS = new Set([
+  ".js", ".jsx", ".ts", ".tsx",
+  ".py",
+  ".go",
+  ".rs",
+  ".java",
+  ".cpp", ".c", ".h", ".hpp",
+  ".cs",
+  ".rb",
+  ".php",
+  ".sh",
+  ".swift",
+  ".kt"
+]);
+
+function isTestOrMockFile(relPath) {
+  const lowerPath = relPath.toLowerCase().replace(/\\/g, "/");
+  return (
+    lowerPath.includes("/test/") ||
+    lowerPath.includes("/tests/") ||
+    lowerPath.includes("/spec/") ||
+    lowerPath.includes("/specs/") ||
+    lowerPath.includes("/mock/") ||
+    lowerPath.includes("/mocks/") ||
+    lowerPath.includes("/__tests__/") ||
+    lowerPath.includes("/__mocks__/") ||
+    lowerPath.includes("test.") ||
+    lowerPath.includes("spec.") ||
+    lowerPath.endsWith(".test") ||
+    lowerPath.endsWith(".spec")
+  );
+}
+
+function getAutoSelectedSnippets(snippets) {
+  const entryKeywords = ["index", "main", "app", "server", "cli", "run", "start", "config"];
+  const scored = snippets.map(s => {
+    let score = 0;
+    const nameLower = s.name.toLowerCase();
+    
+    if (SNIPPET_NAMES.has(s.name)) {
+      score += 100;
+    }
+    if (!s.relativePath.includes("/") && !s.relativePath.includes("\\")) {
+      score += 50; // Root level
+    }
+    if (entryKeywords.some(kw => nameLower.includes(kw))) {
+      score += 30;
+    }
+    // Files in src/, lib/, bin/, etc. (closer to root is better)
+    const depth = s.relativePath.split(/[/\\]/).length - 1;
+    score -= depth * 5; // Deeper files have lower priority
+    
+    return { snippet: s, score };
+  });
+  
+  // Sort in descending order of score
+  scored.sort((a, b) => b.score - a.score);
+  
+  // Select top 20 snippets
+  const maxAutoSelect = 20;
+  return scored.slice(0, maxAutoSelect).map(item => item.snippet.relativePath);
+}
+
+function getExplicitIncludes(includeOption) {
+  if (!includeOption) return [];
+  const rawArray = Array.isArray(includeOption) ? includeOption : [includeOption];
+  const result = [];
+  for (const item of rawArray) {
+    if (typeof item === 'string') {
+      const splitItems = item.split(',').map(s => s.trim()).filter(Boolean);
+      result.push(...splitItems);
+    }
+  }
+  return result;
+}
+
+function processExplicitFile(filePath, rootPath, result) {
+  try {
+    const absolutePath = path.resolve(rootPath, filePath);
+    if (!fs.existsSync(absolutePath)) {
+      console.warn(`\x1b[33m[Warning] Explicitly included file not found: ${filePath}\x1b[0m`);
+      return;
+    }
+    const stats = fs.statSync(absolutePath);
+    if (!stats.isFile()) return;
+
+    const relativePath = path.relative(rootPath, absolutePath);
+    const item = path.basename(absolutePath);
+    const ext = path.extname(item).toLowerCase();
+    const content = fs.readFileSync(absolutePath, "utf-8");
+
+    // Add to language list
+    if (ext === ".ts" || ext === ".tsx") result.languages.add("TypeScript");
+    else if (ext === ".js" || ext === ".jsx") result.languages.add("JavaScript");
+    else if (ext === ".py") result.languages.add("Python");
+    else if (ext === ".go") result.languages.add("Go");
+    else if (ext === ".rs") result.languages.add("Rust");
+    else if (ext === ".java") result.languages.add("Java");
+    else if (ext === ".cpp" || ext === ".c" || ext === ".h" || ext === ".hpp") result.languages.add("C/C++");
+    else if (ext === ".cs") result.languages.add("C#");
+    else if (ext === ".rb") result.languages.add("Ruby");
+    else if (ext === ".php") result.languages.add("PHP");
+    else if (ext === ".swift") result.languages.add("Swift");
+    else if (ext === ".kt" || ext === ".kts") result.languages.add("Kotlin");
+    else if (ext === ".sh") result.languages.add("Shell");
+
+    if (MANIFEST_NAMES.has(item)) {
+      if (!result.manifests.some(m => m.relativePath === relativePath)) {
+        result.manifests.push({ relativePath, name: item, content: content.substring(0, 10000) });
+      }
+    } else if (ext === ".md") {
+      if (!result.markdowns.some(m => m.relativePath === relativePath)) {
+        result.markdowns.push({ relativePath, name: item, content });
+      }
+    } else {
+      if (!result.snippets.some(s => s.relativePath === relativePath)) {
+        result.snippets.push({ relativePath, name: item, content });
+      }
+    }
+  } catch (err) {
+    console.error(`\x1b[31m[Error] Failed to process explicit file '${filePath}': ${err.message}\x1b[0m`);
+  }
+}
+
+function processExplicitPath(inputPath, rootPath, result) {
+  try {
+    const absolutePath = path.resolve(rootPath, inputPath);
+    if (!fs.existsSync(absolutePath)) {
+      console.warn(`\x1b[33m[Warning] Explicit path not found: ${inputPath}\x1b[0m`);
+      return;
+    }
+    const stats = fs.statSync(absolutePath);
+    if (stats.isDirectory()) {
+      const relPath = path.relative(rootPath, absolutePath);
+      scanDirectoryFiles(absolutePath, relPath, result);
+    } else if (stats.isFile()) {
+      processExplicitFile(absolutePath, rootPath, result);
+    }
+  } catch (err) {
+    console.error(`\x1b[31m[Error] Failed to process explicit path '${inputPath}': ${err.message}\x1b[0m`);
+  }
+}
+function getGitRemoteInfo() {
+  try {
+    const remoteUrl = execSync("git remote get-url origin", { encoding: "utf8", stdio: ["ignore", "pipe", "ignore"] }).trim();
+    if (remoteUrl) {
+      let repoUrl = "";
+      let username = "";
+      let repoName = "";
+
+      if (remoteUrl.startsWith("git@")) {
+        const match = remoteUrl.match(/git@[^:]+:([^/]+)\/(.+?)(?:\.git)?$/);
+        if (match) {
+          username = match[1];
+          repoName = match[2];
+          repoUrl = `https://github.com/${username}/${repoName}`;
+        }
+      } else if (remoteUrl.startsWith("http")) {
+        const urlObj = new URL(remoteUrl);
+        const pathParts = urlObj.pathname.split("/").filter(Boolean);
+        if (pathParts.length >= 2) {
+          username = pathParts[0];
+          repoName = pathParts[1].replace(/\.git$/, "");
+          repoUrl = `https://${urlObj.host}/${username}/${repoName}`;
+        }
+      }
+      return { repoUrl, username, repoName };
+    }
+  } catch (_) {}
+  return null;
+}
+
+
+
+
 // 1. Traverse directory to form visual path layout
 function buildTreeString(currentPath, prefix = "") {
   try {
@@ -126,7 +325,7 @@ function scanDirectoryFiles(currentPath, relativePath, result) {
   try {
     const items = fs.readdirSync(currentPath);
     for (const item of items) {
-      if (IGNORED_DIRS.has(item) || item.startsWith(".")) continue;
+      if (IGNORED_DIRS.has(item) || (item.startsWith(".") && item !== ".env.example" && item !== ".env.sample")) continue;
 
       const itemPath = path.join(currentPath, item);
       const itemRelPath = relativePath ? path.join(relativePath, item) : item;
@@ -142,11 +341,33 @@ function scanDirectoryFiles(currentPath, relativePath, result) {
         else if (ext === ".py") result.languages.add("Python");
         else if (ext === ".go") result.languages.add("Go");
         else if (ext === ".rs") result.languages.add("Rust");
+        else if (ext === ".java") result.languages.add("Java");
+        else if (ext === ".cpp" || ext === ".c" || ext === ".h" || ext === ".hpp") result.languages.add("C/C++");
+        else if (ext === ".cs") result.languages.add("C#");
+        else if (ext === ".rb") result.languages.add("Ruby");
+        else if (ext === ".php") result.languages.add("PHP");
+        else if (ext === ".swift") result.languages.add("Swift");
+        else if (ext === ".kt" || ext === ".kts") result.languages.add("Kotlin");
+        else if (ext === ".sh") result.languages.add("Shell");
+
+        const isImage = [".png", ".jpg", ".jpeg", ".svg", ".gif"].includes(ext);
+        if (isImage) {
+          const lowerName = item.toLowerCase();
+          if (lowerName.includes("logo")) {
+            result.detectedLogos.push(itemRelPath);
+          }
+          if (lowerName.includes("screenshot") || lowerName.includes("scrnshot") || lowerName.includes("preview")) {
+            result.detectedScreenshots.push(itemRelPath);
+          }
+        }
 
-        if (MANIFEST_NAMES.has(item)) {
+        const isManifest = MANIFEST_NAMES.has(item);
+        const isSnippetCandidate = (SNIPPET_NAMES.has(item) || SOURCE_EXTENSIONS.has(ext)) && !isTestOrMockFile(itemRelPath);
+
+        if (isManifest) {
           const content = fs.readFileSync(itemPath, "utf-8").substring(0, 10000);
           result.manifests.push({ relativePath: itemRelPath, name: item, content });
-        } else if (SNIPPET_NAMES.has(item) && stats.size < 12000) {
+        } else if (isSnippetCandidate && stats.size < 40000) {
           const content = fs.readFileSync(itemPath, "utf-8");
           result.snippets.push({ relativePath: itemRelPath, name: item, content });
         } else if (ext === ".md" && item.toLowerCase() !== "readme.md" && stats.size < 15000) {
@@ -169,7 +390,7 @@ const showBanner = () => {
  | | \\ \\  __/ (_| | (_| | |  | | \\___|\\__, |    
  |_|  \\_\\___|\\__,_|\\__,_|_|  |_|      |___/     
 \x1b[0m`);
-  console.log(` \x1b[45m\x1b[37m ReadMeg — Interactive CLI v1.0.0 \x1b[0m Powered by Google Gemini AI\n`);
+  console.log(` \x1b[45m\x1b[37m ReadMeg — Interactive CLI v1.0.1 \x1b[0m Powered by Google Gemini AI\n`);
 };
 
 async function main() {
@@ -210,11 +431,20 @@ async function main() {
     manifests: [],
     snippets: [],
     markdowns: [],
-    languages: new Set()
+    languages: new Set(),
+    detectedLogos: [],
+    detectedScreenshots: []
   };
 
   scanDirectoryFiles(activeCwd, "", scanResult);
 
+  if (options.include) {
+    const includes = getExplicitIncludes(options.include);
+    for (const inc of includes) {
+      processExplicitPath(inc, activeCwd, scanResult);
+    }
+  }
+
   let projectType = "Unknown Project Core";
   if (scanResult.manifests.some(m => m.name === "package.json")) projectType = "Node.js (JavaScript/TypeScript)";
   else if (scanResult.manifests.some(m => m.name === "requirements.txt" || m.name === "pyproject.toml")) projectType = "Python";
@@ -224,10 +454,38 @@ async function main() {
   console.log(`\x1b[32mSuccessfully mapped codebase structure as:\x1b[0m ${projectType}`);
   console.log(`Tree Depth loaded. Captured manifests: ${scanResult.manifests.map(m => m.name).join(", ") || "None"}\n`);
 
-  // CLI Selection Loop states
   let selectedManifestPaths = scanResult.manifests.map(m => m.relativePath);
-  let selectedSnippetPaths = scanResult.snippets.map(s => s.relativePath);
+  let selectedSnippetPaths = getAutoSelectedSnippets(scanResult.snippets);
   let selectedMarkdownPaths = scanResult.markdowns.map(md => md.relativePath);
+
+  if (options.include) {
+    const includes = getExplicitIncludes(options.include);
+    for (const inc of includes) {
+      try {
+        const absPath = path.resolve(activeCwd, inc);
+        if (fs.existsSync(absPath) && fs.statSync(absPath).isFile()) {
+          const relPath = path.relative(activeCwd, absPath);
+          if (scanResult.snippets.some(s => s.relativePath === relPath) && !selectedSnippetPaths.includes(relPath)) {
+            selectedSnippetPaths.push(relPath);
+          }
+          if (scanResult.manifests.some(m => m.relativePath === relPath) && !selectedManifestPaths.includes(relPath)) {
+            selectedManifestPaths.push(relPath);
+          }
+          if (scanResult.markdowns.some(md => md.relativePath === relPath) && !selectedMarkdownPaths.includes(relPath)) {
+            selectedMarkdownPaths.push(relPath);
+          }
+        }
+      } catch (_) {}
+    }
+  }
+  const gitInfo = getGitRemoteInfo() || {};
+  let githubUsername = options.githubUser || gitInfo.username || "";
+  let githubRepoUrl = options.repoUrl || gitInfo.repoUrl || "";
+  let twitterUrl = options.twitter || "";
+  let linkedinUrl = options.linkedin || "";
+  let logoPath = options.logo || (scanResult.detectedLogos[0] || "");
+  let screenshotPath = options.screenshot || (scanResult.detectedScreenshots[0] || "");
+
   let addGuidelines = [];
   let customInstructions = "";
   let chosenModel = "gemini-3.5-flash";
@@ -237,9 +495,10 @@ async function main() {
   while (true) {
     const listChoices = [
       { name: "View scanned File Tree diagram", value: "view_tree" },
+      { name: "Configure project metadata (GitHub, Twitter, LinkedIn)", value: "project_metadata" },
       { name: "Select configuration manifest files to analyze", value: "select_manifests" },
       { name: "Select code snippet guides to inspect", value: "select_snippets" },
-      { name: "Select reference markdown files to inspect", value: "select_markdowns" },
+      { name: "Select files to inspect", value: "select_files" },
       { name: "Select supplementary layout headings", value: "select_headings" },
       { name: "Enter custom text highlight instructions", value: "custom_notes" },
       { name: "GENERATE README DOCUMENT RIGHT NOW", value: "trigger_gen" },
@@ -270,6 +529,56 @@ async function main() {
       continue;
     }
 
+    if (activeChoice === "project_metadata") {
+      const metadataAnswers = await inquirer.prompt([
+        {
+          type: "input",
+          name: "username",
+          message: "Enter GitHub Username / Organisation:",
+          default: githubUsername
+        },
+        {
+          type: "input",
+          name: "repoUrl",
+          message: "Enter GitHub Repository URL:",
+          default: githubRepoUrl
+        },
+        {
+          type: "input",
+          name: "twitter",
+          message: "Enter Twitter Profile URL (optional):",
+          default: twitterUrl
+        },
+        {
+          type: "input",
+          name: "linkedin",
+          message: "Enter LinkedIn Profile URL (optional):",
+          default: linkedinUrl
+        },
+        {
+          type: "input",
+          name: "logo",
+          message: "Enter Project Logo Path (optional):",
+          default: logoPath
+        },
+        {
+          type: "input",
+          name: "screenshot",
+          message: "Enter Project Screenshot Path (optional):",
+          default: screenshotPath
+        }
+      ]);
+
+      githubUsername = metadataAnswers.username.trim();
+      githubRepoUrl = metadataAnswers.repoUrl.trim();
+      twitterUrl = metadataAnswers.twitter.trim();
+      linkedinUrl = metadataAnswers.linkedin.trim();
+      logoPath = metadataAnswers.logo.trim();
+      screenshotPath = metadataAnswers.screenshot.trim();
+      console.log("\x1b[32m✔ Project metadata updated.\x1b[0m\n");
+      continue;
+    }
+
     if (activeChoice === "select_manifests") {
       if (scanResult.manifests.length === 0) {
         console.log("\x1b[33mWarning: No manifest files (package.json, requirements.txt, setup.py, Cargo.toml etc) found to check.\x1b[0m\n");
@@ -308,22 +617,83 @@ async function main() {
       continue;
     }
 
-    if (activeChoice === "select_markdowns") {
-      if (scanResult.markdowns.length === 0) {
-        console.log("\x1b[33mWarning: No reference markdown files (.md) found to check. Add some customized docs first!\x1b[0m\n");
-        continue;
-      }
-      const markdownAsk = await inquirer.prompt([
+    if (activeChoice === "select_files") {
+      const subChoices = [
+        { name: "Check / Select files to inspect", value: "select" },
+        { name: "Add custom file or directory path...", value: "add" },
+        { name: "Go back to Main Menu", value: "back" }
+      ];
+      const subMenu = await inquirer.prompt([
         {
-          type: "checkbox",
-          name: "paths",
-          message: "Check markdown documents to inject as key architectural sources:",
-          choices: scanResult.markdowns.map(md => ({ name: md.relativePath, value: md.relativePath, checked: selectedMarkdownPaths.includes(md.relativePath) })),
+          type: "select",
+          name: "action",
+          message: "Select Files to Inspect — Choose a management action:",
+          choices: subChoices,
           loop: false
         }
       ]);
-      selectedMarkdownPaths = markdownAsk.paths;
-      console.log(`\x1b[32m✔ Reference markdown files updated. Total: ${selectedMarkdownPaths.length}\x1b[0m\n`);
+
+      if (subMenu.action === "back") {
+        continue;
+      }
+
+      if (subMenu.action === "add") {
+        const addAsk = await inquirer.prompt([
+          {
+            type: "input",
+            name: "path",
+            message: "Enter the custom file or directory path to scan and inspect:"
+          }
+        ]);
+        const customPath = addAsk.path.trim();
+        if (customPath) {
+          processExplicitPath(customPath, activeCwd, scanResult);
+          try {
+            const absPath = path.resolve(activeCwd, customPath);
+            if (fs.existsSync(absPath)) {
+              if (fs.statSync(absPath).isFile()) {
+                const relPath = path.relative(activeCwd, absPath);
+                const ext = path.extname(relPath).toLowerCase();
+                if (MANIFEST_NAMES.has(path.basename(relPath))) {
+                  if (!selectedManifestPaths.includes(relPath)) selectedManifestPaths.push(relPath);
+                } else if (ext === ".md") {
+                  if (!selectedMarkdownPaths.includes(relPath)) selectedMarkdownPaths.push(relPath);
+                } else {
+                  if (!selectedSnippetPaths.includes(relPath)) selectedSnippetPaths.push(relPath);
+                }
+              }
+              console.log(`\x1b[32m✔ Successfully scanned and added path: ${customPath}\x1b[0m\n`);
+            }
+          } catch (err) {
+            console.error(`\x1b[31m[Error] Failed to resolve path: ${err.message}\x1b[0m\n`);
+          }
+        }
+      }
+
+      if (subMenu.action === "select") {
+        const choices = scanResult.markdowns.map(md => ({
+          name: md.relativePath,
+          value: md.relativePath,
+          checked: selectedMarkdownPaths.includes(md.relativePath)
+        }));
+
+        if (choices.length === 0) {
+          console.log("\x1b[33mNo reference files currently loaded. Choose 'Add custom file or directory path...' to add one.\x1b[0m\n");
+          continue;
+        }
+
+        const selectAsk = await inquirer.prompt([
+          {
+            type: "checkbox",
+            name: "paths",
+            message: "Check files to inject as key architectural sources:",
+            choices,
+            loop: false
+          }
+        ]);
+        selectedMarkdownPaths = selectAsk.paths;
+        console.log(`\x1b[32m✔ Reference files updated. Total: ${selectedMarkdownPaths.length}\x1b[0m\n`);
+      }
       continue;
     }
 
@@ -402,12 +772,12 @@ The document MUST strictly follow this exact outline and formatting sequence:
 
 1. Top Anchors & Shields:
 - Add a top anchor: \`<a name="readme-top"></a>\` at the absolute beginning of the file.
-- Centered shields/badges using raw Markdown with stylish links: Contributors, Forks, Stargazers, Issues, License, LinkedIn. Specify reference URL identifiers at the absolute bottom of the file (e.g. \`[contributors-shield]: ...\`).
+- Centered shields/badges using raw Markdown with stylish links: Contributors, Forks, Stargazers, Issues, License, and (if provided) LinkedIn and Twitter. Specify reference URL identifiers at the absolute bottom of the file (e.g. \`[contributors-shield]: ...\`).
 - Put badges cleanly on top.
 
 2. Project Logo & Headers (Centered):
 - Leave space for logo using \`<br />\` and then a centered div block containing:
-  - An image tag targeting a generic logo placeholder (or repository logo) with dimensions 80x80. Use "https://images.unsplash.com/photo-1618401471353-b98aedd07871?q=80&w=120&auto=format&fit=crop" as a source placeholder if no logo is found.
+  - An image tag targeting the repository logo with dimensions 80x80. If a Logo Path is provided under Project Metadata, use it as the image src (e.g., \`assets/logo.png\`). If not provided, search the provided project structure (e.g., assets/, images/, or root) for any logo image file (like \`logo.png\`, \`logo.svg\`, \`logo.jpg\`, \`assets/logo.png\`). If found, use that file path as the src. If no logo file exists in the repository, use the unsplash placeholder URL: "https://images.unsplash.com/photo-1618401471353-b98aedd07871?q=80&w=120&auto=format&fit=crop".
   - A centered \`<h3 align="center">Project Title</h3>\`
   - A short, descriptive project subtitle.
   - Links to Explore the Docs, View Demo, Report Bug, Request Feature centering on appropriate URLs.
@@ -417,7 +787,7 @@ The document MUST strictly follow this exact outline and formatting sequence:
 
 4. About the Project:
 - Place a section title \`## About The Project\` with a paragraph detailing what issues the library solves and why.
-- Provide a placeholder screenshot element (\`[![Product Name Screen Shot][product-screenshot]](https://example.com)\`).
+- Provide a screenshot element (\`[![Product Name Screen Shot][product-screenshot]](https://example.com)\`). If a Screenshot Path is provided under Project Metadata, ensure the \`[product-screenshot]\` reference at the bottom resolves to that file path (e.g., \`assets/screenshot.png\`). If not provided, search the project structure for any screenshot image file (like \`screenshot.png\`, \`screenshot.jpg\`, \`assets/screenshot.png\`). If found, ensure the \`[product-screenshot]\` reference at the bottom resolves to that file path (e.g., \`assets/screenshot.png\`). If no screenshot file is found, resolve the reference to the unsplash placeholder: "https://images.unsplash.com/photo-1618401471353-b98aedd07871?q=80&w=600&auto=format&fit=crop".
 - Add a \`### Built With\` subsection with raw shields list linking to core framework technologies identified in the manifests or languages (e.g. Next.js, React, Python, Go, Rust, etc., with shields like \`* [![React][React.js]][React-url]\`).
 - Add \`<p align="right">(<a href="#readme-top">back to top</a>)</p>\` at the end of this and ALL subsequent major sections.
 
@@ -449,6 +819,22 @@ The document MUST strictly follow this exact outline and formatting sequence:
 
 ${addGuidelines.length > 0 ? `Include these extra specific layout headings inside the layout: ${addGuidelines.map(sec => `- ${sec}`).join("\n")}` : ""}
 
+Project Metadata for customization (use these when constructing URLs, shields, badges, and contact references):
+- GitHub Username: ${githubUsername || "Not provided"}
+- GitHub Repository URL: ${githubRepoUrl || "Not provided"}
+- Twitter URL: ${twitterUrl || "Not provided"}
+- LinkedIn URL: ${linkedinUrl || "Not provided"}
+- Logo Path: ${logoPath || "Not provided"}
+- Screenshot Path: ${screenshotPath || "Not provided"}
+
+Instructions for metadata integration:
+1. Construct GitHub shields (Contributors, Forks, Stars, Issues, License) and their URL references using the provided GitHub Username and Repository name (extracted from the Repo URL).
+2. If a LinkedIn URL is provided, include a LinkedIn shield at the top (using badge image URL e.g. "https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555") and define its bottom link reference pointing to the LinkedIn URL. If not, omit the LinkedIn shield.
+3. If a Twitter URL is provided, include a Twitter/X shield at the top (using badge image URL e.g. "https://img.shields.io/badge/-Twitter-black.svg?style=for-the-badge&logo=x&colorB=555" or "https://img.shields.io/badge/-Twitter-black.svg?style=for-the-badge&logo=twitter&colorB=555") and define its bottom link reference pointing to the Twitter URL. If not, omit the Twitter shield.
+4. Under the Contact section, list the user's contact information using the provided Twitter and LinkedIn links.
+5. If a Logo Path is provided, use it exactly as the src of the project logo image.
+6. If a Screenshot Path is provided, ensure the bottom reference \`[product-screenshot]\` resolves to it.
+
 Do not write markdown block fences inside the generated readme itself unless wrapping code examples. Do not add any conversational meta-talk. Output the raw Best-README-Template markdown directly.`;
 
         const prompt = `Generate a README.md file based on the following codebase analysis:
@@ -462,6 +848,7 @@ ${snippetsBlock}
 
 ${markdownsBlock}
 
+${githubUsername || githubRepoUrl || twitterUrl || linkedinUrl || logoPath || screenshotPath ? `Project Metadata:\n- GitHub Username: ${githubUsername || "N/A"}\n- GitHub Repository: ${githubRepoUrl || "N/A"}\n- Twitter: ${twitterUrl || "N/A"}\n- LinkedIn: ${linkedinUrl || "N/A"}\n- Logo Path: ${logoPath || "N/A"}\n- Screenshot Path: ${screenshotPath || "N/A"}\n` : ""}
 ${customInstructions ? `Custom User directives:\n${customInstructions}\n` : ""}
 
 Generate the complete, polished Markdown output directly without any extra conversation.`;
@@ -597,6 +984,12 @@ async function runDirectScanAndGen() {
   console.log("Running zero-config non-interactive codebase scans...");
   const activeCwd = process.cwd();
   
+  const gitInfo = getGitRemoteInfo() || {};
+  const githubUsername = options.githubUser || gitInfo.username || "";
+  const githubRepoUrl = options.repoUrl || gitInfo.repoUrl || "";
+  const twitterUrl = options.twitter || "";
+  const linkedinUrl = options.linkedin || "";
+
   let treeBody = "";
   try {
     treeBody = buildTreeString(activeCwd);
@@ -608,16 +1001,28 @@ async function runDirectScanAndGen() {
   const scanResult = {
     manifests: [],
     snippets: [],
-    languages: new Set()
+    markdowns: [],
+    languages: new Set(),
+    detectedLogos: [],
+    detectedScreenshots: []
   };
 
   try {
     scanDirectoryFiles(activeCwd, "", scanResult);
+    if (options.include) {
+      const includes = getExplicitIncludes(options.include);
+      for (const inc of includes) {
+        processExplicitPath(inc, activeCwd, scanResult);
+      }
+    }
   } catch (err) {
     console.error(`\x1b[31mERROR: Detailed file scanning failed: ${err.message}\x1b[0m`);
     process.exit(1);
   }
 
+  const logoPath = options.logo || (scanResult.detectedLogos[0] || "");
+  const screenshotPath = options.screenshot || (scanResult.detectedScreenshots[0] || "");
+
   const apiKey = options.apiKey || process.env.GEMINI_API_KEY;
   if (!apiKey || !apiKey.trim()) {
     console.error("\x1b[31mERROR: Gemini API key is missing. Run with --api-key=KEY or set the GEMINI_API_KEY environment variable.\x1b[0m");
@@ -634,25 +1039,132 @@ async function runDirectScanAndGen() {
       }
     });
 
+    const baseSelectedSnippets = getAutoSelectedSnippets(scanResult.snippets);
+    const selectedSnippetPaths = baseSelectedSnippets.slice(0, 15);
+
+    if (options.include) {
+      const includes = getExplicitIncludes(options.include);
+      for (const inc of includes) {
+        try {
+          const absPath = path.resolve(activeCwd, inc);
+          if (fs.existsSync(absPath) && fs.statSync(absPath).isFile()) {
+            const relPath = path.relative(activeCwd, absPath);
+            if (scanResult.snippets.some(s => s.relativePath === relPath) && !selectedSnippetPaths.includes(relPath)) {
+              selectedSnippetPaths.push(relPath);
+            }
+          }
+        } catch (_) {}
+      }
+    }
+
+    const filteredSnippets = scanResult.snippets.filter(s => selectedSnippetPaths.includes(s.relativePath));
+
     let manifestsBlock = "";
     scanResult.manifests.forEach(m => {
-      manifestsBlock += `\n--- file: ${m.relativePath} ---\n\`\`\`\n${m.content}\n\`\`\`\n`;
+      manifestsBlock += `\n--- Manifest File: ${m.relativePath} ---\n\`\`\`\n${m.content}\n\`\`\`\n`;
     });
 
-    const prompt = `Generate a README.md file based on the following codebase layout tree:
+    let snippetsBlock = "";
+    filteredSnippets.forEach(s => {
+      snippetsBlock += `\n--- Code Snippet: ${s.relativePath} ---\n\`\`\`\n${s.content}\n\`\`\`\n`;
+    });
+
+    let markdownsBlock = "";
+    scanResult.markdowns.forEach(md => {
+      markdownsBlock += `\n--- Reference Markdown File: ${md.relativePath} ---\n\`\`\`markdown\n${md.content}\n\`\`\`\n`;
+    });
+
+    const systemInstruction = `Role: You are an expert technical writer and principal software architect.
+Task: Your job is to generate a comprehensive, highly polished, professional README.md file based only on the provided directory structure, project configuration files, and references, formatted EXACTLY using the Best-README-Template by @othneildrew.
+
+Visual Layout / Structure Requirements (Derived from othneildrew/Best-README-Template):
+The document MUST strictly follow this exact outline and formatting sequence:
+
+1. Top Anchors & Shields:
+- Add a top anchor: \`<a name="readme-top"></a>\` at the absolute beginning of the file.
+- Centered shields/badges using raw Markdown with stylish links: Contributors, Forks, Stargazers, Issues, License, and (if provided) LinkedIn and Twitter. Specify reference URL identifiers at the absolute bottom of the file (e.g. \`[contributors-shield]: ...\`).
+- Put badges cleanly on top.
+
+2. Project Logo & Headers (Centered):
+- Leave space for logo using \`<br />\` and then a centered div block containing:
+  - An image tag targeting the repository logo with dimensions 80x80. If a Logo Path is provided under Project Metadata, use it as the image src (e.g., \`assets/logo.png\`). If not provided, search the provided project structure (e.g., assets/, images/, or root) for any logo image file (like \`logo.png\`, \`logo.svg\`, \`logo.jpg\`, \`assets/logo.png\`). If found, use that file path as the src. If no logo file exists in the repository, use the unsplash placeholder URL: "https://images.unsplash.com/photo-1618401471353-b98aedd07871?q=80&w=120&auto=format&fit=crop".
+  - A centered \`<h3 align="center">Project Title</h3>\`
+  - A short, descriptive project subtitle.
+  - Links to Explore the Docs, View Demo, Report Bug, Request Feature centering on appropriate URLs.
+
+3. Interactive Detail-TOC (Table of Contents):
+- Add a table of contents enclosed in a Collapsible Details panel (\`<details><summary>Table of Contents</summary>...\` using list elements with anchors pointing to respective sections: About The Project, Getting Started (Prerequisites, Installation), Usage, Roadmap, Contributing, License, Contact, Acknowledgments).
+
+4. About the Project:
+- Place a section title \`## About The Project\` with a paragraph detailing what issues the library solves and why.
+- Provide a screenshot element (\`[![Product Name Screen Shot][product-screenshot]](https://example.com)\`). If a Screenshot Path is provided under Project Metadata, ensure the \`[product-screenshot]\` reference at the bottom resolves to that file path (e.g., \`assets/screenshot.png\`). If not provided, search the project structure for any screenshot image file (like \`screenshot.png\`, \`screenshot.jpg\`, \`assets/screenshot.png\`). If found, ensure the \`[product-screenshot]\` reference at the bottom resolves to that file path (e.g., \`assets/screenshot.png\`). If no screenshot file is found, resolve the reference to the unsplash placeholder: "https://images.unsplash.com/photo-1618401471353-b98aedd07871?q=80&w=600&auto=format&fit=crop".
+- Add a \`### Built With\` subsection with raw shields list linking to core framework technologies identified in the manifests or languages (e.g. Next.js, React, Python, Go, Rust, etc., with shields like \`* [![React][React.js]][React-url]\`).
+- Add \`<p align="right">(<a href="#readme-top">back to top</a>)</p>\` at the end of this and ALL subsequent major sections.
+
+5. Getting Started:
+- Place \`## Getting Started\` heading.
+- Include \`### Prerequisites\` listing key runtime versions or engines with raw commands (e.g., npm or pip).
+- Include \`### Installation\` with custom sequential steps: Clone repository, Install dependencies/packages using correct package manager commands, Setup key constants/configs.
+
+6. Usage:
+- Place \`## Usage\` heading with direct code instructions, visual scripts invocation, and explanation.
+
+7. Roadmap:
+- Place \`## Roadmap\` heading highlighting future planning milestones or upcoming revisions. Use standard markdown task lists (e.g., \`- [ ] Feature 1\`).
+
+8. Contributing:
+- Place \`## Contributing\` heading detailing the exact five-step guidelines for forks, branching, commits, and pull request initiation.
+
+9. License:
+- Place \`## License\` heading highlighting the standard licensing info (e.g. MIT License).
+
+10. Contact:
+- Place \`## Contact\` heading listing author/maintainer contact points, project links, or email tags.
+
+11. Acknowledgments:
+- Place \`## Acknowledgments\` heading listing standard resources (e.g., Shields.io, select libraries, or other credits).
+
+12. Bottom Link References:
+- At the absolute bottom of the document, define ALL referenced links and shield assets used at the top and Built With section dynamically to keep the rest of the text bodies pristine (e.g., \`[contributors-shield]: ...\`).
+
+Project Metadata for customization (use these when constructing URLs, shields, badges, and contact references):
+- GitHub Username: ${githubUsername || "Not provided"}
+- GitHub Repository URL: ${githubRepoUrl || "Not provided"}
+- Twitter URL: ${twitterUrl || "Not provided"}
+- LinkedIn URL: ${linkedinUrl || "Not provided"}
+- Logo Path: ${logoPath || "Not provided"}
+- Screenshot Path: ${screenshotPath || "Not provided"}
+
+Instructions for metadata integration:
+1. Construct GitHub shields (Contributors, Forks, Stars, Issues, License) and their URL references using the provided GitHub Username and Repository name (extracted from the Repo URL).
+2. If a LinkedIn URL is provided, include a LinkedIn shield at the top (using badge image URL e.g. "https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555") and define its bottom link reference pointing to the LinkedIn URL. If not, omit the LinkedIn shield.
+3. If a Twitter URL is provided, include a Twitter/X shield at the top (using badge image URL e.g. "https://img.shields.io/badge/-Twitter-black.svg?style=for-the-badge&logo=x&colorB=555" or "https://img.shields.io/badge/-Twitter-black.svg?style=for-the-badge&logo=twitter&colorB=555") and define its bottom link reference pointing to the Twitter URL. If not, omit the Twitter shield.
+4. Under the Contact section, list the user's contact information using the provided Twitter and LinkedIn links.
+5. If a Logo Path is provided, use it exactly as the src of the project logo image.
+6. If a Screenshot Path is provided, ensure the bottom reference \`[product-screenshot]\` resolves to it.
+
+Do not write markdown block fences inside the generated readme itself unless wrapping code examples. Do not add any conversational meta-talk. Output the raw Best-README-Template markdown directly.`;
+
+    const prompt = `Generate a README.md file based on the following codebase analysis:
 
 Project Structure:
 ${treeBody}
 
 ${manifestsBlock}
 
+${snippetsBlock}
+
+${markdownsBlock}
+
+${githubUsername || githubRepoUrl || twitterUrl || linkedinUrl || logoPath || screenshotPath ? `Project Metadata:\n- GitHub Username: ${githubUsername || "N/A"}\n- GitHub Repository: ${githubRepoUrl || "N/A"}\n- Twitter: ${twitterUrl || "N/A"}\n- LinkedIn: ${linkedinUrl || "N/A"}\n- Logo Path: ${logoPath || "N/A"}\n- Screenshot Path: ${screenshotPath || "N/A"}\n` : ""}
+
 Generate the complete, polished Markdown output directly without any extra conversation.`;
 
     const response = await ai.models.generateContent({
       model: "gemini-3.5-flash",
       contents: prompt,
       config: {
-        systemInstruction: "You are an expert technical writer. Write a comprehensive, polished production-ready README.md file directly.",
+        systemInstruction,
         temperature: 0.2
       }
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "readmeg",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Zero-config terminal tool powered by Gemini that automatically generates comprehensive, production-grade README files for local repositories.",
   "type": "module",
   "bin": {