fix readmet

Author: james-pplx

fact_checker_cli/README.md

@@ -1,122 +1,101 @@
-# Fact Checker CLI
+Fact Checker CLI
 
-A command-line tool that identifies false or misleading claims in articles or statements using Perplexity's Sonar API for web research.
+A command-line tool that identifies false or misleading claims in articles or statements using Perplexity’s Sonar API for web research.
 
-## Features
+Features
+	•	Analyze claims or entire articles for factual accuracy
+	•	Identify false, misleading, or unverifiable claims
+	•	Provide explanations and corrections for inaccurate information
+	•	Output results in human-readable format or structured JSON
+	•	Cite reliable sources for fact-checking assessments
+	•	Leverages Perplexity’s structured outputs for reliable JSON parsing (for Tier 3+ users)
 
-- Analyze claims or entire articles for factual accuracy
-- Identify false, misleading, or unverifiable claims
-- Provide explanations and corrections for inaccurate information
-- Output results in human-readable format or structured JSON
-- Cite reliable sources for fact-checking assessments
-- Leverages Perplexity's structured outputs for reliable JSON parsing (for Tier 3+ users)
+Installation
+	1.	Install required dependencies:
 
-## Installation
+pip install requests pydantic
 
 
-1. Install required dependencies:
+	2.	Make the script executable:
 
-```bash
-pip install requests pydantic
-```
+chmod +x fact_checker.py
 
-2. Make the script executable:
 
-```bash
-chmod +x fact_checker.py
-```
 
-## API Key Setup
+API Key Setup
 
 The tool requires a Perplexity API key to function. You can provide it in one of these ways:
+	1.	As a command-line argument: --api-key YOUR_API_KEY
+	2.	As an environment variable: export PPLX_API_KEY=YOUR_API_KEY
+	3.	In a file named pplx_api_key or .pplx_api_key in the same directory as the script:
 
-1. As a command-line argument: `--api-key YOUR_API_KEY`
-2. As an environment variable: `export PPLX_API_KEY=YOUR_API_KEY`
-3. In a file named `pplx_api_key` or `.pplx_api_key` in the same directory as the script:
-
-```bash
 # Create a file to store your API key
 echo "YOUR_API_KEY" > .pplx_api_key
 # Make sure to protect your API key
 chmod 600 .pplx_api_key
-```
 
-**Note:** If you're using the structured outputs feature, you'll need a Perplexity API account with Tier 3 or higher access level.
 
-## Quick Start
 
-Here's a command you can copy and run immediately after setup:
+Note: If you’re using the structured outputs feature, you’ll need a Perplexity API account with Tier 3 or higher access level.
+
+Quick Start
+
+Here’s a command you can copy and run immediately after setup:
 
-```bash
 # Make sure your API key is set up as described above, then run:
 ./fact_checker.py -t "The Earth is flat and NASA is hiding the truth."
-```
 
-This will analyze the claim, research it using Perplexity's Sonar API, and return a detailed fact check with ratings, explanations, and sources.
+This will analyze the claim, research it using Perplexity’s Sonar API, and return a detailed fact check with ratings, explanations, and sources.
 
-## Usage
+Usage
 
-### Basic Usage
+Basic Usage
 
 Check a claim:
 
-```bash
 ./fact_checker.py --text "The Earth is flat and NASA is hiding the truth."
-```
 
-### Check an article from a file:
+Check an Article from a File
 
-```bash
 ./fact_checker.py --file article.txt
-```
 
-### Specify a different model:
+Specify a Different Model
 
-```bash
 ./fact_checker.py --text "Global temperatures have decreased over the past century." --model "sonar-pro"
-```
 
-### Output results as JSON:
+Output Results as JSON
 
-```bash
 ./fact_checker.py --text "Mars has a breathable atmosphere." --json
-```
 
-### Use a custom prompt file:
+Use a Custom Prompt File
 
-```bash
 ./fact_checker.py --text "The first human heart transplant was performed in the United States." --prompt-file custom_prompt.md
-```
 
-### Disable structured outputs (for lower tier accounts):
+Enable Structured Outputs (for Tier 3+ Users)
 
-```bash
-./fact_checker.py --text "Vaccines cause autism." --no-structured-output
-```
+Structured output is disabled by default. If you want to enable structured outputs (for reliable JSON parsing), pass the --structured-output flag:
 
-### Get help:
+./fact_checker.py --text "Vaccines cause autism." --structured-output
 
-```bash
-./fact_checker.py --help
-```
+Get Help
 
-## Output Format
+./fact_checker.py --help
 
-The tool provides a structured output with:
+Output Format
 
-- Overall rating of the content (MOSTLY_TRUE, MIXED, or MOSTLY_FALSE)
-- Summary of findings
-- List of specific claims with individual ratings:
-  - TRUE: Factually accurate and supported by evidence
-  - FALSE: Contradicted by evidence
-  - MISLEADING: Contains some truth but presented in a way that could lead to incorrect conclusions
-  - UNVERIFIABLE: Cannot be conclusively verified with available information
-- Explanations for each claim
-- Sources used for verification
+The tool provides output including:
+	•	Overall rating: MOSTLY_TRUE, MIXED, or MOSTLY_FALSE
+	•	Summary: A brief overview of the fact-checking findings
+	•	Claims Analysis: A list of specific claims with individual ratings:
+	•	TRUE: Factually accurate and supported by evidence
+	•	FALSE: Contradicted by evidence
+	•	MISLEADING: Contains some truth but presented in a way that could lead to incorrect conclusions
+	•	UNVERIFIABLE: Cannot be conclusively verified with available information
+	•	Explanations: Detailed reasoning for each claim
+	•	Sources: Citations and URLs used for verification
 
-## Example
+Example
 
-```
 $ ./fact_checker.py -t "The Great Wall of China is visible from the moon."
 
 Fact checking in progress...
@@ -135,11 +114,12 @@ Claim 1: ❌ FALSE
     - NASA.gov
     - Scientific American
     - National Geographic
-```
 
-## Limitations
+Limitations
+	•	The accuracy of fact-checking depends on the quality of information available through the Perplexity Sonar API
+	•	Like all language models, the underlying AI may have limitations in certain specialized domains
+	•	The structured outputs feature requires a Tier 3 or higher Perplexity API account
+	•	The tool does not replace professional fact-checking services for highly sensitive or complex content
+
+⸻
 
-- The accuracy of fact-checking depends on the quality of information available through the Perplexity Sonar API
-- Like all language models, the underlying AI may have limitations in certain specialized domains
-- The structured outputs feature requires a Tier 3 or higher Perplexity API account
-- The tool does not replace professional fact-checking services for highly sensitive or complex content