DOCS_INDEX.md

ReferralBox Documentation Index

Welcome to the ReferralBox gem documentation! Here's everything you need to get started and become an expert.

📚 Documentation Files

🚀 Getting Started

• README.md - Main overview and basic setup
• QUICK_START.md - Get running in 5 minutes
• DOCUMENTATION.md - Complete developer guide

📋 Reference

• CHANGELOG.md - Version history and changes
• LICENSE.txt - MIT License

🎯 Choose Your Path

👶 New to ReferralBox?

1. Start with README.md for overview
2. Follow QUICK_START.md to get running
3. Read DOCUMENTATION.md for advanced features

🔧 Ready to Integrate?

1. Jump to DOCUMENTATION.md
2. Check the Installation section
3. Review Configuration options
4. See Examples for real-world usage

🛠️ Need Help?

1. Check Troubleshooting section
2. Review API Reference
3. Look at Integration Examples

📖 Quick Navigation

Installation & Setup

• Quick Start Guide
• Installation Steps
• Configuration Options

Core Features

• Points System
• Tier System
• Referral System

API Reference

• Core Methods
• Model Methods
• Configuration Options

Advanced Usage

• Custom Earning Rules
• Integration Examples
• Admin Dashboard

Troubleshooting

• Common Issues
• Debug Mode
• Support

🎉 What You'll Learn

Basic Usage

# Earn points
ReferralBox.earn_points(user, 100)

# Check balance
balance = ReferralBox.balance(user)

# Track referrals
ReferralBox.track_referral(ref_code: params[:ref])

Advanced Features

• Custom earning rules with lambda functions
• Dynamic tier assignment
• Referral analytics and tracking
• Admin dashboard with beautiful UI
• Points expiration and management

🚀 Ready to Start?

Choose your path:

• Quick Start - Get running in 5 minutes
• Full Documentation - Complete guide with examples
• API Reference - All methods and options

---

Happy coding with ReferralBox! 🎉