Add Colab quickstart link and update project description

[barun-saha]

Close #180.

Summary by CodeRabbit

• Documentation
  • Updated and restructured README with improved clarity on features, workflows, and capabilities
  • Enhanced branding messaging, headings, and visual callouts
  • Expanded Python API quickstart documentation
  • Refreshed LLM provider options and AI model information
  • Enhanced privacy and security messaging
  • Clarified offline generation capabilities and setup instructions
  • Improved overall formatting and presentation

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This pull request updates the README.md documentation with a comprehensive branding refresh, restructured workflow sections, new Python API quickstart content, overhauled LLM provider descriptions, enhanced privacy/security messaging, and improved offline generation guidance.

Changes

Cohort / File(s)

Summary

Documentation Branding & Content Refresh README.md

Expands SlideDeck AI README with reworked title and descriptive messaging; restructures workflow section from "Process" to "How It Works: The Automated Deck Generation Process" with multi-step enumeration; adds new Python API quickstart section; replaces "Live Demo" block with "Experience the power now!" callouts; overhauls LLM section from "Summary of the LLMs" to "Unmatched Flexibility: Choose Your AI Brain" with updated provider naming (Azure/OpenAI, Google, SambaNova, Together AI, OpenRouter) and free tier notes; refreshes privacy/security block with shielded tone and open-source clarity; enhances offline generation section with Ollama usage instructions and RUN_IN_OFFLINE_MODE example; applies emoji-enhanced headings and formatting updates throughout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Documentation-only changes with no code logic or API modifications
• Content restructuring and branding updates are straightforward and visually verifiable
• No functional changes that require logic validation

Possibly related PRs

• Fixes #116 - Update README.md #118: Updates README's LLM/provider sections and model entries with naming and content changes
• Update documentation #128: Adds documentation for offline mode environment variables (RUN_IN_OFFLINE_MODE) and related configuration
• Update contributions #148: Performs broad README.md branding refresh with section heading restructuring and LLM/offline instructions updates

Poem

🐰 Hop, hop! The README now gleams,
With shiny new branding and AI-powered dreams,
Workflows laid clear in bold, titled prose,
Ollama offline flows and LLM's glow—
Your deck-generation journey in words we compose! ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings, 1 inconclusive)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	Issue #180 requires adding a Colab quickstart notebook, but the changeset only shows README.md updates without evidence of a Colab notebook creation or quickstart link addition.	Create and commit the Colab notebook file or add a direct link to a Colab quickstart in the README to fulfill issue #180 requirements.
Out of Scope Changes check	⚠️ Warning	The PR includes extensive README restructuring, branding updates, and content rewrites that appear broader than the stated objective of adding a Colab quickstart link.	Either split the PR to isolate the Colab quickstart addition, or update the issue scope to include all documentation changes being made.
Title check	❓ Inconclusive	The PR title mentions adding a Colab quickstart link and updating project description, but the actual changes only involve README documentation updates without evidence of a Colab quickstart addition.	Clarify whether a Colab notebook or link was added as part of this PR; if not, the title should reflect that only README content updates were made.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch visual

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

116-116: Fix markdown emphasis style inconsistency.

Per markdownlint (MD049), emphasis should use asterisks (*) instead of underscores (_). Update _only_ to *only* on this line.

Apply this diff:

- Your key is _only_ used to invoke the relevant LLM for content generation—and that's it! As a fully **Open-Source** project, we encourage you to audit the code yourself for complete peace of mind.
+ Your key is *only* used to invoke the relevant LLM for content generation—and that's it! As a fully **Open-Source** project, we encourage you to audit the code yourself for complete peace of mind.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2670d27 and 553f9da.

📒 Files selected for processing (1)

• README.md (5 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

116-116: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

---

116-116: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: test (3.10)

🔇 Additional comments (3)

README.md (3)

49-51: ✅ Colab quickstart link successfully added—primary objective achieved.

The new "Python API Quickstart" section includes a prominent Colab badge and link, directly addressing the PR objective to provide a ready-to-run example. This should help users get started quickly.

However, please verify that the linked Colab notebook (https://colab.research.google.com/drive/1YA9EEmyiQFk03bOSc7lZnxK5l2hAL60l?usp=sharing) is accessible and contains appropriate quickstart content that complements the code example shown in the README.

---

58-58: Verify the model code in the quickstart example.

The example uses '[gg]gemini-2.5-flash-lite' as the model identifier. Confirm this code matches the supported LLM table below (lines 94-112) and is currently valid.

---

47-64: Python API Quickstart section well-structured with clear narrative.

The new section flows logically from heading through Colab link to a practical code example. The example is concise and includes helpful comments. Good addition to guide users toward the Python API.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!