# Limelink

> Dynamic Link Service for Mobile Applications

Limelink is a lightweight, affordable, and easy-to-use dynamic link service designed for individuals and small teams.

## Documentation

### Getting Started
- [Introduction](/md/introduction.md): Service overview, key benefits, and why choose Limelink
- [Getting Started](/md/getting-started.md): Quick start guide for creating projects, applications, and links

### Core Concepts
- [Project](/md/project.md): Top-level unit for managing links, applications, and analytics
- [Application](/md/application.md): iOS/Android app configuration (App ID, scheme, store ID, SHA-256)
- [Dynamic Link](/md/dynamic-link.md): Universal URL that works across all platforms with platform-specific behaviors

### Link Management
- [Create Link](/md/create-link.md): Step-by-step guide for creating dynamic links (5 steps)
- [Link Detail](/md/link-detail.md): View link information, behavior settings, and user analytics
- [Link Management](/md/link-management.md): Managing and customizing dynamic links
- [Appearance](/md/appearance.md): Visual theme settings for URI scheme-based navigation (10 predefined themes)

### SDK Integration
- [SDK Integration](/md/sdk-integration.md): Overview of iOS/Android SDK capabilities (Universal Links, Deferred Deep Links)
- [iOS SDK](/md/ios-sdk.md): CocoaPods installation, Universal Link handling, Deferred Deep Link support
- [Android SDK](/md/android-sdk.md): JitPack installation, App Links handling, Install Referrer integration

### API & Advanced
- [API Integration](/md/api-integration.md): REST API for programmatic link creation (POST /api/v1/core/link)
- [Advanced](/md/advanced.md): Advanced features including SDK capabilities and server-side integration

---

## Quick Reference

### Key Features
- Single link for all platforms (iOS, Android, Web)
- App installation-based routing (open app or redirect to store)
- Universal Links and Deferred Deep Links (Pro plan)
- Real-time analytics (page views, conversions, platform breakdown)
- UTM parameter support for campaign tracking
- Social preview customization (title, description, image)

### Pricing

| Plan | Price | Conversions | Domain | Features |
|------|-------|-------------|--------|----------|
| Free | $0 | Up to 50,000 | `deep.limelink.org/{suffix}` | Basic dynamic links, analytics |
| Pro | $10/month | Unlimited | `{project}.limelink.org/link/{suffix}` | Universal Links, Deferred Deep Links, branded subdomain |

### SDK Quick Install

**iOS (CocoaPods):**
```ruby
pod 'LimelinkIOSSDK'
```

**Android (Gradle):**
```gradle
maven { url 'https://jitpack.io' }
implementation 'com.github.hellovelope:limelink-aos-sdk:main'
```

### API Endpoint

```
POST https://api.limelink.org/api/v1/core/link
Header: X-API-KEY: {your_api_key}
```

---

## Links

- Website: https://limelink.org
- Dashboard: https://limelink.org/dashboard
- Pricing: https://limelink.org/pricing
- iOS SDK: https://cocoapods.org/pods/LimelinkIOSSDK
- Android SDK: https://jitpack.io/#hellovelope/limelink-aos-sdk