@pranavraut033/ats-checker 1.0.0 → 1.0.2

package/README.md

@@ -1,47 +1,100 @@
 # ats-checker
 
-Deterministic, configurable ATS (Applicant Tracking System) compatibility checker with no external dependencies. Provides a single entry point `analyzeResume()` and extensible configuration for weights, skills, rules, and profiles.
+A zero-dependency TypeScript library for evaluating resume compatibility with Applicant Tracking Systems (ATS). It parses resumes and job descriptions, calculates a deterministic score from 0 to 100, and provides actionable feedback to improve match rates.
 
 ## Installation
 
 ```bash
-npm install ats-checker
+npm install @pranavraut033/ats-checker
 ```
 
-## Quick start
+## Usage
 
-```ts
-import { analyzeResume } from "ats-checker";
+```typescript
+import { analyzeResume } from "@pranavraut033/ats-checker";
 
-const { score, breakdown, suggestions } = analyzeResume({
-  resumeText: "...",
-  jobDescription: "..."
+const result = analyzeResume({
+  resumeText: `John Doe
+Software Engineer with 5 years of experience in JavaScript and React.`,
+  jobDescription: `We are looking for a software engineer with JavaScript experience.`
 });
+
+console.log(result.score); // 78
+console.log(result.breakdown.skills); // 85
+console.log(result.suggestions); // ["Add more specific JavaScript frameworks", ...]
 ```
 
 ## Configuration
 
-- **weights**: adjust scoring weight for skills, experience, keywords, and education.
-- **skillAliases**: normalize synonyms to canonical skills.
-- **profile**: specify mandatory/optional skills and minimum years of experience.
-- **rules**: add custom penalties via functions that inspect parsed resume/job data.
+Adjust scoring priorities, define skill synonyms, and add custom rules:
+
+```typescript
+const result = analyzeResume({
+  resumeText: "...",
+  jobDescription: "...",
+  config: {
+    weights: { skills: 0.4, experience: 0.3, keywords: 0.2, education: 0.1 },
+    skillAliases: { "javascript": ["js", "ecmascript"] },
+    rules: [{
+      id: "no-tables",
+      penalty: 10,
+      condition: (context) => context.resume.hasTables
+    }]
+  }
+});
+```
+
+See [Configuration](docs/configuration.md) for complete options.
+
+## Features
+
+- Deterministic scoring based on skills, experience, keywords, and education
+- Detects common ATS issues like missing sections or keyword overuse
+- Customizable scoring weights and validation rules
+- Optional LLM integration for enhanced suggestions
+- Includes a web interface for testing (`npm run dev`)
+- [Live Demo](https://pranavraut033.github.io/ats-checker/)
+
+## API
+
+### `analyzeResume(input: AnalyzeResumeInput): AnalyzeResumeResult`
+
+Analyzes a resume against a job description.
+
+**Input:**
+- `resumeText: string` - The full text of the resume
+- `jobDescription: string` - The job description text
+- `config?: ATSConfig` - Optional configuration overrides
 
-See `src/types` for full type definitions.
+**Output:**
+- `score: number` - Overall ATS score (0-100)
+- `breakdown: ATSBreakdown` - Component scores
+- `matchedKeywords: string[]` - Keywords found in both
+- `missingKeywords: string[]` - Important keywords not in resume
+- `suggestions: string[]` - Improvement recommendations
+- `warnings: string[]` - Issues detected
 
 ## Development
 
 ```bash
 npm install
-npm run build
-npm test
+npm run build    # Build to dist/
+npm test         # Run tests
+npm run dev      # Start web UI at http://localhost:3000
 ```
 
-## Features
+## Documentation
+
+**Live Docs** (hosted on GitHub Pages):
+- https://Pranavraut033.github.io/ats-checker/docs/
+
+**Local Docs** (in repository):
+- [Configuration Guide](docs/configuration.md)
+- [LLM Integration](docs/llm-integration.md)
+- [Web Interface](docs/ui.md)
+- [Architecture](docs/architecture.md)
+
+## License
 
-- Zero runtime dependencies
-- Deterministic, explainable scoring (0-100)
-- Customizable weights, rules, and industry profiles
-- Parses resumes and job descriptions
-- Detects ATS-unfriendly patterns (tables, keyword stuffing)
-- Generates actionable suggestions
+MIT
 

package/dist/index.d.mts

@@ -382,6 +382,7 @@ declare const LLMPrompts: {
     suggestionEnhancementSystem: string;
     /**
      * User prompt for suggestion enhancement
+     * IMPORTANT: Includes strict JSON schema to ensure consistent output across all LLM providers
      */
     suggestionEnhancementUser: (suggestions: string[]) => string;
     /**

package/dist/index.d.ts

@@ -382,6 +382,7 @@ declare const LLMPrompts: {
     suggestionEnhancementSystem: string;
     /**
      * User prompt for suggestion enhancement
+     * IMPORTANT: Includes strict JSON schema to ensure consistent output across all LLM providers
      */
     suggestionEnhancementUser: (suggestions: string[]) => string;
     /**

package/dist/index.js

@@ -1100,11 +1100,23 @@ Maintain the core message but make it more concrete.
 Return ONLY valid JSON.`,
   /**
    * User prompt for suggestion enhancement
+   * IMPORTANT: Includes strict JSON schema to ensure consistent output across all LLM providers
    */
   suggestionEnhancementUser: (suggestions) => `Enhance these suggestions for clarity and actionability:
 ${suggestions.map((s) => `- ${s}`).join("\n")}
 
-Make them specific and measurable where possible.`,
+Make them specific and measurable where possible.
+
+CRITICAL: You MUST return ONLY valid JSON in this exact format (no markdown, no extra text):
+{
+  "suggestions": [
+    {
+      "original": "the original suggestion text",
+      "enhanced": "your improved, more actionable version",
+      "actionable": true
+    }
+  ]
+}`,
   /**
    * System prompt for JD clarification
    */