project-readme-gen/src/index.js

AI-powered README.md generator for your projects. Automatically creates professional project documentation with CLI support. Generate structured, SEO-friendly markdown documentation for your GitHub repositories.

const fs = require("fs-extra");
const path = require("path");
const glob = require("glob");
const axios = require("axios"); // For making HTTP requests

const PROXY_ENDPOINT = "https://project-readme-gen.vercel.app";

const analyzeProject = (projectPath) => {
  const files = glob.sync(`${projectPath}/**/*`, {
    nodir: true,
    ignore: ["**/node_modules/**", "**/dist/**"],
  });
  const analysis = files.map((file) => {
    const content = fs.readFileSync(file, "utf-8");
    return { file, content: content.slice(0, 500) }; // Limit content size
  });
  return analysis;
};

const generateReadme = async (projectAnalysis) => {
  const readmeSections = await Promise.all(
    projectAnalysis.map(async ({ file, content }) => {
      const seoFriendlyPrompt = `
File: ${file}
Content (truncated):
${content}

Generate a detailed, SEO-friendly section for a GitHub README that includes:
1. Clear descriptive headings using markdown (##)
2. A brief but compelling project description
3. Key features in bullet points
4. Technologies/dependencies used
5. Installation and usage instructions (if applicable)
6. Code examples (if relevant)
7. Include relevant keywords naturally
8. Add badges where appropriate (build status, version, license)

Format the output in markdown and ensure it's scannable and well-structured.`;

      try {
        const response = await axios.post(PROXY_ENDPOINT, { prompt: seoFriendlyPrompt });
        console.log(response, " this is response");
        return response.data.content; // Adjust based on your proxy server's response format
      } catch (error) {
        console.error(`Error generating content for ${file}:`, error.response?.status, error.response?.data, error.message);
        return "";
      }
    })
  );
  return readmeSections.filter((section) => section).join("\n\n");
};

const writeReadme = (projectPath, content) => {
  const readmePath = path.join(projectPath, "README.md");
  fs.writeFileSync(readmePath, content, "utf-8");
  console.log(`README generated at ${readmePath}`);
};

module.exports = async (projectPath) => {
  const analysis = analyzeProject(projectPath);
  const readmeContent = await generateReadme(analysis);
  writeReadme(projectPath, readmeContent);
};