docs

Author: kholdrex

irt_ruby.gemspec

@@ -8,25 +8,38 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alex Kholodniak"]
   spec.email         = ["alexandrkholodniak@gmail.com"]
 
-  spec.summary       = "A Ruby gem that provides Rasch, 2PL, and 3PL models for Item Response Theory (IRT), with flexible missing data strategies."
+  spec.summary       = "Production-ready Item Response Theory (IRT) models with comprehensive performance benchmarking and adaptive optimization."
   spec.description   = <<~DESC
-    IrtRuby provides implementations of the Rasch model, Two-Parameter model,#{" "}
-    and Three-Parameter model for Item Response Theory (IRT).#{" "}
-    It allows you to estimate the abilities of individuals and the difficulties,#{" "}
-    discriminations, and guessing parameters of items based on their responses#{" "}
-    to a set of items. This version adds support for multiple missing data#{" "}
-    strategies (:ignore, :treat_as_incorrect, :treat_as_correct), expanded#{" "}
-    test coverage, and improved adaptive optimization.
+    IrtRuby is a comprehensive Ruby library for Item Response Theory (IRT) analysis,#{" "}
+    commonly used in educational assessment, psychological testing, and survey research.
+
+    Features three core IRT models:
+    • Rasch Model (1PL) - Simple difficulty-only model
+    • Two-Parameter Model (2PL) - Adds item discrimination
+    • Three-Parameter Model (3PL) - Includes guessing parameter
+
+    Key capabilities:
+    • Robust gradient ascent optimization with adaptive learning rates
+    • Flexible missing data strategies (ignore, treat as incorrect/correct)
+    • Comprehensive performance benchmarking suite
+    • Memory-efficient implementation with excellent scaling
+    • Production-ready with extensive test coverage
+
+    Perfect for researchers, data scientists, and developers working with#{" "}
+    educational assessments, psychological measurements, or any binary response data
+    where item and person parameters need to be estimated simultaneously.
   DESC
 
   spec.homepage      = "https://github.com/SyntaxSpirits/irt_ruby"
   spec.license       = "MIT"
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["homepage_uri"]    = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/SyntaxSpirits/irt_ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/SyntaxSpirits/irt_ruby/blob/main/CHANGELOG.md"
+  spec.metadata["changelog_uri"]   = "https://github.com/SyntaxSpirits/irt_ruby/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://github.com/SyntaxSpirits/irt_ruby#readme"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/SyntaxSpirits/irt_ruby/issues"
 
-  spec.files = Dir["lib/**/*.rb"]
+  spec.files = Dir["lib/**/*.rb", "benchmarks/**/*", "README.md", "CHANGELOG.md", "LICENSE.txt"]
   spec.required_ruby_version = ">= 2.6"
 
   spec.bindir      = "exe"
@@ -35,7 +48,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "matrix", "~> 0.4.2"
 
+  spec.add_development_dependency "benchmark-ips", "~> 2.0"
   spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "memory_profiler", "~> 1.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end