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

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

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 - Project overview and quick start
• Admin Dashboard - Management interface guide
• API Endpoints - Complete API reference

Common Tasks

• Add New Model: Model Management Guide
• Configure Authentication: Authentication Setup
• Set Up Firebase: Main README

🚀 Getting Started

1. Set up Firebase - Required for persistence
2. Configure API Keys - Add your AI service keys
3. Deploy to HF - Run locally or deploy
4. Manage Models - Add and configure AI models
5. Set up Users - Configure authentication

🆘 Need Help?

If you can't find what you're looking for:

1. Check the main README 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!