Skip to content

Commit b55808b

Browse files
committed
Add demo and Vercel deploy section to README
Update CI badge to target the ci.yml workflow Embed a demo GIF for quick visual overview Add Vercel deploy button with API key setup notes Refine formatting of code blocks and closing punctuation
1 parent 5da82f3 commit b55808b

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,20 @@
33
> Your intelligent pet journal powered by AI. Track, analyze, and understand your furry friend's well-being.
44
55
[![Live Demo](https://img.shields.io/badge/Live%20Demo-petalytics.vercel.app-blue)](https://petalytics.vercel.app)
6-
[![CI/CD](https://github.com/gitcoder89431/petalytics/workflows/CI/badge.svg)](https://github.com/gitcoder89431/petalytics/actions)
6+
[![CI](https://github.com/gitcoder89431/petalytics/actions/workflows/ci.yml/badge.svg)](https://github.com/gitcoder89431/petalytics/actions/workflows/ci.yml)
7+
8+
## 🎥 Demo
9+
10+
![Petalytics demo](./demo_full.gif)
11+
12+
## ▲ Deploy to Vercel
13+
14+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fgitcoder89431%2Fpetalytics)
15+
16+
Notes:
17+
18+
- No server secrets needed; set your OpenRouter API key inside the app (Guardian panel).
19+
- Default free model is enforced: `openai/gpt-oss-120b:free`.
720

821
## ✨ Features
922

@@ -138,7 +151,7 @@ npm run check # Type checking
138151

139152
### Architecture
140153

141-
```
154+
```text
142155
┌─────────────────┬─────────────────┐
143156
│ Guardian Panel │ │
144157
├─────────────────┤ Main Viewport │
@@ -171,4 +184,4 @@ MIT License - see [LICENSE](LICENSE) for details.
171184

172185
---
173186

174-
**Made with ❤️ for pets and their humans**
187+
Made with ❤️ for pets and their humans.

demo_full.gif

838 KB
Loading

0 commit comments

Comments
 (0)