LLM README Tester Banner

💡 Turn your README into tested code.
This GitHub Action runs LLM-powered unit tests on your README.md using Google’s Gemini API **.
You can now **customize which checks to run, generate markdown reports, and keep your workflows green.

-----------------------------------------------------

✅ What it checks

  • 📌 Project description
  • 🧪 Installation instructions
  • 🧰 Usage examples
  • 📄 License info
  • 📸 Screenshot or live demo link

Tip: You can disable specific tests using the checks input.

-----------------------------------------------------

🚀 Quickstart

Drop this into your workflow to automatically test your README:

- uses: atick-faisal/llm-readme-tester@v1
  with:
    google_api_key: $
    checks: "description,install,license"  # optional, default is "all"

🧠 Available check keywords: description, install, usage, license, demo
🔐 Add your Gemini API key as a secret named GOOGLE_API_KEY.

-----------------------------------------------------

🧪 Example Output

test_readme.py ....F                                                     [100%]

FAILED test_readme.py::test_license_info - ❌ License information is missing.

📚 Docs & Community

-----------------------------------------------------

Qatar University Machine Learning Group