readme_generator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67b444019cd2d5154e470c0c3bca6d9ce3b1fe2e600dadb2f250dfdbf92ead2b
+  data.tar.gz: 2d4ee26f78c6ee16f79c8e85599893d8bb32ea1b1b3a6f26788f1418cb26b199
+SHA512:
+  metadata.gz: 8e59c543b7bb53c87ee5d6511802f59cec3a854cb4ec3e42af5f1c947763fe8cd984ef58e35d1a85fe77296870127a10177115a36580e09354b0cdd3938d427c
+  data.tar.gz: 58d9669d8e49c0e559754f008752fc1393560981a512cbb8db01e5aa241e0eb52e962a218fd8363bfc6afc59b6e16ae4e3caf127d4b0085d30b0891d04b1bcfc

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Saud M.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# README Generator
+
+An intelligent Ruby CLI tool that analyzes your projects and generates comprehensive README.md files automatically.
+
+## Features
+
+- **Smart Project Analysis**: Automatically detects project type (React, Next.js, Node.js, Python, etc.)
+- **Package.json Parsing**: Extracts dependencies, scripts, author, and project metadata
+- **Intelligent Template Selection**: Chooses optimal README template based on project structure
+- **Multi-Framework Support**: Supports React, Next.js, Vue.js, Node.js, Python, Ruby, and more
+
+## Technical Implementation
+
+- **JSON Processing**: Advanced parsing with error handling and data validation
+- **File System Operations**: Efficient file I/O and path manipulation
+- **Data Structures**: Complex hash manipulation and merging strategies
+- **Template Engine**: Dynamic content generation using ERB templating
+- **Error Management**: Robust exception handling with graceful fallbacks
+
+## Installation
+
+### Clone and Build
+```bash
+git clone https://github.com/saud06/readme-generator.git
+cd readme-generator
+gem build readme_generator.gemspec
+```
+
+### macOS
+```bash
+gem install ./readme_generator-1.0.0.gem
+```
+
+### Linux
+```bash
+gem install --user-install ./readme_generator-1.0.0.gem
+echo 'export PATH="$HOME/.gem/ruby/2.6.0/bin:$PATH"' >> ~/.bashrc
+source ~/.bashrc
+```
+
+### Windows
+```bash
+gem install --user-install ./readme_generator-1.0.0.gem
+echo 'export PATH="$HOME/.gem/ruby/2.6.0/bin:$PATH"' >> ~/.bash_profile
+source ~/.bash_profile
+```
+
+## Usage
+
+Generate a README for the current directory:
+```bash
+readme-gen
+```
+
+Generate a README for a specific project:
+```bash
+readme-gen /path/to/your/project
+```
+
+## License
+
+MIT License

data/exe/readme-gen

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/readme_generator'
+
+begin
+  ReadmeGenerator::CLI.start(ARGV)
+rescue Interrupt
+  puts "\n\nExiting..."
+  exit 1
+rescue StandardError => e
+  puts "Error: #{e.message}"
+  exit 1
+end

data/lib/readme_generator/cli.rb

@@ -0,0 +1,64 @@
+require 'thor'
+
+module ReadmeGenerator
+  class CLI < Thor
+    include Thor::Actions
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'version', 'Show version information'
+    def version
+      puts "README Generator v#{ReadmeGenerator::VERSION}"
+    end
+
+    desc 'generate [PATH]', 'Generate README.md for the project'
+    option :template, type: :string, aliases: '-t', desc: 'Template type (basic, nodejs, react, nextjs, vue, nuxtjs, python, flask, laravel)'
+    def generate(path = Dir.pwd)
+      project_path = File.expand_path(path)
+
+      unless Dir.exist?(project_path)
+        puts "Error: Directory '#{path}' does not exist."
+        exit 1
+      end
+
+      readme_path = File.join(project_path, 'README.md')
+      if File.exist?(readme_path)
+        print "README.md already exists. Overwrite? (y/N): "
+        return unless gets.chomp.downcase == 'y'
+      end
+
+      puts "Generating README.md..."
+      
+      begin
+        generator = Generator.new(project_path, { template: options[:template] })
+        output_path = generator.generate
+
+        puts "✅ README.md generated successfully at: #{output_path}"
+      rescue StandardError => e
+        puts "❌ Error: #{e.message}"
+        exit 1
+      end
+    end
+
+    desc 'init', 'Create a basic README.md file'
+    def init
+      project_name = File.basename(Dir.pwd)
+      
+      puts "Creating README.md for: #{project_name}"
+      
+      readme_path = File.join(Dir.pwd, 'README.md')
+      if File.exist?(readme_path)
+        print "README.md already exists. Overwrite? (y/N): "
+        return unless gets.chomp.downcase == 'y'
+      end
+
+      generator = Generator.new(Dir.pwd, { project_name: project_name })
+      output_path = generator.generate
+
+      puts "✅ README.md created at: #{output_path}"
+    end
+
+  end
+end

data/lib/readme_generator/config_manager.rb

@@ -0,0 +1,6 @@
+module ReadmeGenerator
+  class ConfigManager
+    # Simple config manager - not needed for basic version
+    # Keeping class for compatibility but removing complex features
+  end
+end

data/lib/readme_generator/scanner.rb

@@ -0,0 +1,168 @@
+require 'json'
+
+module ReadmeGenerator
+  class Scanner
+    def initialize(project_path)
+      @project_path = File.expand_path(project_path)
+    end
+
+    def scan
+      base_info = {
+        name: File.basename(@project_path),
+        type: detect_project_type,
+        language: detect_project_language,
+        recommended_template: 'basic'
+      }
+      
+      # Add enhanced package.json analysis for Node.js projects
+      if File.exist?(File.join(@project_path, 'package.json'))
+        package_info = analyze_package_json
+        base_info.merge!(package_info)
+      end
+      
+      base_info
+    end
+
+    private
+
+    def detect_project_type
+      # Use file-based detection first (highest priority)
+      return 'nextjs' if File.exist?(File.join(@project_path, 'next.config.js'))
+      return 'nuxtjs' if File.exist?(File.join(@project_path, 'nuxt.config.js'))
+      return 'laravel' if File.exist?(File.join(@project_path, 'artisan'))
+      return 'flask' if File.exist?(File.join(@project_path, 'app.py'))
+      
+      # For JavaScript projects, use smart dependency-based detection
+      if File.exist?(File.join(@project_path, 'package.json'))
+        return detect_js_framework_type
+      end
+      
+      # Check for other languages
+      return 'python' if File.exist?(File.join(@project_path, 'requirements.txt'))
+      return 'ruby' if File.exist?(File.join(@project_path, 'Gemfile'))
+      
+      'basic'
+    end
+
+    # Smart JavaScript framework detection with priority system
+    def detect_js_framework_type
+      begin
+        package_content = File.read(File.join(@project_path, 'package.json'))
+        package_data = JSON.parse(package_content)
+        deps = (package_data['dependencies'] || {}).merge(package_data['devDependencies'] || {})
+        
+        # Priority-based framework detection (most specific first)
+        return 'nextjs' if deps.key?('next')
+        return 'nuxtjs' if deps.key?('nuxt')
+        
+        # Check for full-stack patterns (React + Express = nodejs template)
+        if deps.key?('react') && deps.key?('express')
+          return 'nodejs'  # Full-stack app gets Node.js template
+        end
+        
+        # Frontend frameworks
+        return 'react' if deps.key?('react')
+        return 'vue' if deps.key?('vue')
+        
+        # Check for Node.js server indicators
+        if deps.key?('express') || deps.key?('koa') || deps.key?('fastify')
+          return 'nodejs'
+        end
+        
+        # Default to nodejs for any package.json project
+        return 'nodejs'
+        
+      rescue JSON::ParserError => e
+        puts "Warning: Could not parse package.json for framework detection - #{e.message}"
+        return 'nodejs'  # Safe fallback
+      end
+    end
+
+    def detect_project_language
+      return 'JavaScript' if File.exist?(File.join(@project_path, 'package.json'))
+      return 'Python' if File.exist?(File.join(@project_path, 'requirements.txt'))
+      return 'PHP' if File.exist?(File.join(@project_path, 'composer.json'))
+      return 'Ruby' if File.exist?(File.join(@project_path, 'Gemfile'))
+      'Unknown'
+    end
+
+    # Enhanced package.json analysis
+    def analyze_package_json
+      package_path = File.join(@project_path, 'package.json')
+      
+      begin
+        # Read and parse the JSON file
+        package_content = File.read(package_path)
+        package_data = JSON.parse(package_content)
+        
+        # Extract useful information using Ruby's safe navigation
+        {
+          description: package_data['description'] || 'A Node.js project',
+          version: package_data['version'] || '1.0.0',
+          author: extract_author_info(package_data['author']),
+          dependencies: analyze_dependencies(package_data['dependencies'] || {}),
+          scripts: extract_scripts(package_data['scripts'] || {}),
+          main_file: package_data['main'] || 'index.js',
+          keywords: package_data['keywords'] || []
+        }
+      rescue JSON::ParserError, Errno::ENOENT => e
+        # If JSON is malformed or file doesn't exist, return defaults
+        puts "Warning: Could not parse package.json - #{e.message}"
+        {
+          description: 'A Node.js project',
+          version: '1.0.0',
+          author: 'Unknown',
+          dependencies: [],
+          scripts: [],
+          main_file: 'index.js',
+          keywords: []
+        }
+      end
+    end
+
+    # Extract author information (can be string or object)
+    def extract_author_info(author_data)
+      case author_data
+      when String
+        author_data
+      when Hash
+        author_data['name'] || 'Unknown'
+      else
+        'Unknown'
+      end
+    end
+
+    # Analyze dependencies to identify frameworks and tools
+    def analyze_dependencies(deps)
+      frameworks = []
+      
+      # Check for popular frameworks and libraries
+      frameworks << 'React' if deps.key?('react')
+      frameworks << 'Vue.js' if deps.key?('vue')
+      frameworks << 'Angular' if deps.key?('@angular/core')
+      frameworks << 'Express.js' if deps.key?('express')
+      frameworks << 'Next.js' if deps.key?('next')
+      frameworks << 'Nuxt.js' if deps.key?('nuxt')
+      frameworks << 'TypeScript' if deps.key?('typescript')
+      frameworks << 'Webpack' if deps.key?('webpack')
+      frameworks << 'Vite' if deps.key?('vite')
+      
+      frameworks
+    end
+
+    # Extract and categorize npm scripts
+    def extract_scripts(scripts)
+      important_scripts = []
+      
+      # Look for common script patterns
+      important_scripts << { name: 'start', command: scripts['start'] } if scripts['start']
+      important_scripts << { name: 'dev', command: scripts['dev'] } if scripts['dev']
+      important_scripts << { name: 'build', command: scripts['build'] } if scripts['build']
+      important_scripts << { name: 'test', command: scripts['test'] } if scripts['test']
+      important_scripts << { name: 'lint', command: scripts['lint'] } if scripts['lint']
+      
+      important_scripts
+    end
+
+  end
+end

data/lib/readme_generator/template_builder.rb

@@ -0,0 +1,34 @@
+require 'erb'
+
+module ReadmeGenerator
+  class TemplateBuilder
+    def initialize(project_info, options = {})
+      @project_info = project_info
+      @options = options
+    end
+
+    def build
+      # Smart template selection: Choose template based on project type
+      template_name = @options[:template] || @project_info[:type] || 'basic'
+      template_path = File.join(templates_dir, "#{template_name}.erb")
+      
+      # Fall back to basic template if specified template doesn't exist
+      unless File.exist?(template_path)
+        template_path = File.join(templates_dir, 'basic.erb')
+      end
+
+      template_content = File.read(template_path)
+      erb = ERB.new(template_content)
+      
+      # Simple binding with project name
+      project_name = @options[:project_name] || @project_info[:name] || 'My Project'
+      erb.result(binding)
+    end
+
+    private
+
+    def templates_dir
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+  end
+end

data/lib/readme_generator/templates/basic.erb

@@ -0,0 +1,31 @@
+# <%= project_name %>
+
+A simple project created with README Generator.
+
+## Description
+
+This is a basic project template. Add your project description here.
+
+## Installation
+
+```bash
+# Add installation instructions here
+```
+
+## Usage
+
+```bash
+# Add usage examples here
+```
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/templates/flask.erb

@@ -0,0 +1,54 @@
+# <%= project_name %>
+
+A Flask application created with README Generator.
+
+## Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+## Usage
+
+```bash
+# Development server
+flask run
+
+# Or with Python
+python app.py
+```
+
+Open [http://localhost:5000](http://localhost:5000) to view it in the browser.
+
+## Environment Setup
+
+```bash
+# Create .env file
+echo "FLASK_APP=app.py" > .env
+echo "FLASK_ENV=development" >> .env
+
+# Set environment variables
+export FLASK_APP=app.py
+export FLASK_ENV=development
+```
+
+## Available Commands
+
+```bash
+flask run            # Start development server
+flask shell          # Start Flask shell
+python -m pytest     # Run tests
+pip freeze           # List dependencies
+```
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/templates/laravel.erb

@@ -0,0 +1,55 @@
+# <%= project_name %>
+
+A Laravel application created with README Generator.
+
+## Installation
+
+```bash
+composer install
+cp .env.example .env
+php artisan key:generate
+```
+
+## Usage
+
+```bash
+php artisan serve
+```
+
+Open [http://localhost:8000](http://localhost:8000) to view it in the browser.
+
+## Database Setup
+
+```bash
+# Configure database in .env file
+# Then run migrations
+php artisan migrate
+```
+
+## Available Commands
+
+```bash
+php artisan serve       # Start development server
+php artisan migrate     # Run database migrations
+php artisan make:model  # Create a new model
+php artisan make:controller # Create a new controller
+composer install       # Install dependencies
+```
+
+## Requirements
+
+- PHP >= 8.0
+- Composer
+- MySQL/PostgreSQL (optional)
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/templates/nextjs.erb

@@ -0,0 +1,54 @@
+# <%= project_name %>
+
+<%= @project_info[:description] || "A Next.js application created with README Generator." %>
+
+<% if @project_info[:version] %>**Version:** <%= @project_info[:version] %><% end %>
+<% if @project_info[:author] && @project_info[:author] != 'Unknown' %>**Author:** <%= @project_info[:author] %><% end %>
+
+<% if @project_info[:dependencies] && !@project_info[:dependencies].empty? %>
+## Technologies Used
+
+<% @project_info[:dependencies].each do |framework| %>- <%= framework %>
+<% end %>
+<% end %>
+
+## Installation
+
+```bash
+npm install
+```
+
+## Usage
+
+```bash
+npm run dev      # Start development server
+npm run build    # Build for production
+npm start        # Start production server
+```
+
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+## Available Scripts
+
+```bash
+npm run dev      # Runs the app in development mode
+npm run build    # Builds the app for production
+npm start        # Starts the production server
+npm run lint     # Runs ESLint
+```
+
+## Deployment
+
+The easiest way to deploy your Next.js app is to use [Vercel](https://vercel.com/).
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/templates/nodejs.erb

@@ -0,0 +1,56 @@
+# <%= project_name %>
+
+<%= @project_info[:description] || "A Node.js project created with README Generator." %>
+
+<% if @project_info[:version] %>**Version:** <%= @project_info[:version] %><% end %>
+<% if @project_info[:author] && @project_info[:author] != 'Unknown' %>**Author:** <%= @project_info[:author] %><% end %>
+
+<% if @project_info[:dependencies] && !@project_info[:dependencies].empty? %>
+## Technologies Used
+
+<% @project_info[:dependencies].each do |framework| %>- <%= framework %>
+<% end %>
+<% end %>
+
+## Installation
+
+```bash
+npm install
+```
+
+## Usage
+
+```javascript
+const <%= project_name.gsub('-', '') %> = require('<%= project_name %>');
+
+// Add usage examples here
+```
+
+<% if @project_info[:scripts] && !@project_info[:scripts].empty? %>
+## Available Scripts
+
+<% @project_info[:scripts].each do |script| %>```bash
+npm run <%= script[:name] %>    # <%= script[:command] %>
+```
+
+<% end %>
+<% else %>
+## Scripts
+
+```bash
+npm start    # Start the application
+npm test     # Run tests
+```
+<% end %>
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/templates/nuxtjs.erb

@@ -0,0 +1,44 @@
+# <%= project_name %>
+
+A Nuxt.js application created with README Generator.
+
+## Installation
+
+```bash
+npm install
+```
+
+## Usage
+
+```bash
+npm run dev      # Start development server
+npm run build    # Build for production
+npm run start    # Start production server
+```
+
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+## Available Scripts
+
+```bash
+npm run dev      # Start development server with hot reload
+npm run build    # Build the application for production
+npm run start    # Start production server
+npm run generate # Generate static project
+```
+
+## Deployment
+
+Deploy to [Netlify](https://netlify.com/) or [Vercel](https://vercel.com/) for static sites.
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/templates/python.erb

@@ -0,0 +1,51 @@
+# <%= project_name %>
+
+A Python project created with README Generator.
+
+## Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+## Usage
+
+```python
+python main.py
+```
+
+## Virtual Environment (Recommended)
+
+```bash
+# Create virtual environment
+python -m venv venv
+
+# Activate virtual environment
+# On Windows:
+venv\Scripts\activate
+# On macOS/Linux:
+source venv/bin/activate
+
+# Install dependencies
+pip install -r requirements.txt
+```
+
+## Available Scripts
+
+```bash
+python main.py           # Run the main application
+python -m pytest        # Run tests
+python -m pip freeze     # List installed packages
+```
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/templates/react.erb

@@ -0,0 +1,59 @@
+# <%= project_name %>
+
+<%= @project_info[:description] || "A React application created with README Generator." %>
+
+<% if @project_info[:version] %>**Version:** <%= @project_info[:version] %><% end %>
+<% if @project_info[:author] && @project_info[:author] != 'Unknown' %>**Author:** <%= @project_info[:author] %><% end %>
+
+<% if @project_info[:dependencies] && !@project_info[:dependencies].empty? %>
+## Technologies Used
+
+<% @project_info[:dependencies].each do |framework| %>- <%= framework %>
+<% end %>
+<% end %>
+
+## Installation
+
+```bash
+npm install
+```
+
+## Usage
+
+```bash
+npm start    # Start development server
+npm run build    # Build for production
+```
+
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+<% if @project_info[:scripts] && !@project_info[:scripts].empty? %>
+## Available Scripts
+
+<% @project_info[:scripts].each do |script| %>```bash
+npm run <%= script[:name] %>    # <%= script[:command] %>
+```
+
+<% end %>
+<% else %>
+## Available Scripts
+
+```bash
+npm start        # Runs the app in development mode
+npm test         # Launches the test runner
+npm run build    # Builds the app for production
+npm run eject    # Ejects from Create React App
+```
+<% end %>
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/templates/vue.erb

@@ -0,0 +1,39 @@
+# <%= project_name %>
+
+A Vue.js application created with README Generator.
+
+## Installation
+
+```bash
+npm install
+```
+
+## Usage
+
+```bash
+npm run serve    # Start development server
+npm run build    # Build for production
+```
+
+Open [http://localhost:8080](http://localhost:8080) to view it in the browser.
+
+## Available Scripts
+
+```bash
+npm run serve    # Compiles and hot-reloads for development
+npm run build    # Compiles and minifies for production
+npm run test     # Run tests
+npm run lint     # Lints and fixes files
+```
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a pull request
+
+## License
+
+This project is licensed under the MIT License.

data/lib/readme_generator/version.rb

@@ -0,0 +1,3 @@
+module ReadmeGenerator
+  VERSION = '1.0.0'
+end

data/lib/readme_generator.rb

@@ -0,0 +1,32 @@
+require_relative 'readme_generator/version'
+require_relative 'readme_generator/cli'
+require_relative 'readme_generator/scanner'
+require_relative 'readme_generator/template_builder'
+require_relative 'readme_generator/config_manager'
+
+module ReadmeGenerator
+  class Error < StandardError; end
+
+  # Main entry point for the README Generator
+  class Generator
+    attr_reader :project_path, :options
+
+    def initialize(project_path = Dir.pwd, options = {})
+      @project_path = File.expand_path(project_path)
+      @options = options
+    end
+
+    def generate(output_filename = 'README.md')
+      scanner = Scanner.new(project_path)
+      project_info = scanner.scan
+
+      template_builder = TemplateBuilder.new(project_info, options)
+      readme_content = template_builder.build
+
+      output_path = File.join(project_path, output_filename)
+      File.write(output_path, readme_content)
+
+      output_path
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: readme_generator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Saud M.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Generate README files for your projects with templates
+email:
+- saud.mn6@gmail.com
+executables:
+- readme-gen
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- exe/readme-gen
+- lib/readme_generator.rb
+- lib/readme_generator/cli.rb
+- lib/readme_generator/config_manager.rb
+- lib/readme_generator/scanner.rb
+- lib/readme_generator/template_builder.rb
+- lib/readme_generator/templates/basic.erb
+- lib/readme_generator/templates/flask.erb
+- lib/readme_generator/templates/laravel.erb
+- lib/readme_generator/templates/nextjs.erb
+- lib/readme_generator/templates/nodejs.erb
+- lib/readme_generator/templates/nuxtjs.erb
+- lib/readme_generator/templates/python.erb
+- lib/readme_generator/templates/react.erb
+- lib/readme_generator/templates/vue.erb
+- lib/readme_generator/version.rb
+homepage: https://github.com/saud06/readme-generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: An intelligent CLI tool to generate README.md files
+test_files: []