docs/README.md

# 📚 NyanProxy Documentation

Welcome to the NyanProxy documentation! Here you'll find detailed guides and tutorials for all features.

## 📖 Available Guides

### 🧬 [Model Management](model-management.md)
Learn how to dynamically add, configure, and manage AI models through the admin interface.

- Adding new models (like gpt-4.1, o1-preview, etc.)
- Configuring model properties and costs
- Managing model whitelisting and security
- Understanding usage analytics

### 🔐 [Authentication Setup](../AUTHENTICATION.md)
Comprehensive guide to user management and authentication modes.

- Setting up user tokens
- Configuring authentication modes
- Managing user quotas and permissions

## 🎯 Quick Reference

### Essential Links
- **[Main README](../README.md)** - Project overview and quick start
- **[Admin Dashboard](../README.md#-api-endpoints)** - Management interface guide
- **[API Endpoints](../README.md#-api-endpoints)** - Complete API reference

### Common Tasks
- **Add New Model**: [Model Management Guide](model-management.md#adding-a-new-model)
- **Configure Authentication**: [Authentication Setup](../AUTHENTICATION.md)
- **Set Up Firebase**: [Main README](../README.md#step-1-firebase-database-setup-required)

## 🚀 Getting Started

1. **[Set up Firebase](../README.md#step-1-firebase-database-setup-required)** - Required for persistence
2. **[Configure API Keys](../README.md#step-2-api-keys-setup)** - Add your AI service keys
3. **[Deploy to HF](../README.md#step-3-local-development)** - Run locally or deploy
4. **[Manage Models](model-management.md)** - Add and configure AI models
5. **[Set up Users](../AUTHENTICATION.md)** - Configure authentication

## 🆘 Need Help?

If you can't find what you're looking for:
1. Check the [main README](../README.md) for basic setup
2. Look through the specific guide for your feature
3. Create an issue on the repository with your question

---

*Documentation is continuously updated as new features are added!*