Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ren6 committed Jan 10, 2024
1 parent bfe5fa7 commit 99951ae
Show file tree
Hide file tree
Showing 647 changed files with 761 additions and 664 deletions.
4 changes: 2 additions & 2 deletions ApphudSDK/Public/ApphudPaywall.swift
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ public enum ApphudPaywallID: String {
let paywall = await Apphud.paywall(ApphudPaywallID.onboarding.rawValue)
```

- Note: An alternative way of getting ``Apphud/paywalls``
- Note: An alternative way of getting ``Apphud/paywalls()``

- Important: For more information - [Paywalls Documentation](https://docs.apphud.com/docs/paywalls)
*/

Expand Down
17 changes: 12 additions & 5 deletions Documentation.docc/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Apphud is all-in-one infrastructure for your app growth. Apphud helps marketing
* [Subscriptions Infrastructure](https://docs.apphud.com/docs/ios) - integrate in-app purchases and subscriptions in your mobile app in 2 lines of code. No server code required. Apphud works with all apps on iOS, iPadOS, MacOS, tvOS, watchOS and Android. Cross-platform support out of the box.
* [Real-time Revenue Analytics](https://docs.apphud.com/docs/dashboard) - view key subscription metrics in our dashboard and charts, like MRR, Subscriber Retention (Cohorts), Churn rate, ARPU, Trial Conversions, Proceeds, Refunds, etc.
* [Integrations](https://docs.apphud.com/docs/appsflyer) - Send subscription events to your favorite third party platforms with automatic currency conversion. Choose from 18 integrations, including: AppsFlyer, Adjust, Branch, Firebase, Amplitude, Mixpanel, OneSignal, Facebook, TikTok, and more. Custom Server-to-Server webhooks and APIs are also available.
* [A/B Experiments](https://docs.apphud.com/docs/experiments) - Test different in-app purchases and paywalls. Run experiments to find the best combination of prices and purchase screen parameters that maximize ROI.
* [A/B Experiments](https://docs.apphud.com/docs/experiments) - Test different in-app purchases and paywalls. Run experiments to find the best combination of prices and purchase screen parameters that maximise ROI.
* [Web-to-App](https://docs.apphud.com/docs/web-to-app-solution) - solution overcomes IDFA limitations in the post iOS 14.5 era. Using this solution you can run paid campaigns in Facebook or TikTok and get real-time attribution with nearly 100% accuracy.
* [Rules](https://docs.apphud.com/docs/rules) - Apphud may win back lapsed subscribers, reduce churn rate, get cancellation insights, send push notifications and many more using the mechanics below. This mechanics are called Rules. Choose between manual, scheduled and automated rule. Use our visual web editor to create you custom screen or screen sequence for Rule, and analyze user stats from every created screen.

Expand All @@ -15,26 +15,33 @@ Sign up [for free](https://app.apphud.com).

### The easiest way to integrate in-app subscriptions

Apphud provides ready-to-use infrastructure for all kinds of in-app purchases. Integrate Apphud SDK and implement 3 lines of code:
Apphud provides ready-to-use infrastructure for all kinds of in-app purchases: subscriptions, consumables and non-consumables. Integrate Apphud SDK and implement 3 lines of code:

```swift
// Init SDK
Apphud.start(apiKey: "api_key")

// SDK 3.2.0 and above
// Get Placement by Identifier, and then get it's paywall
let placement = await Apphud.placement(ApphudPlacementID.onboarding.rawValue)

// SDK below 3.2.0
// Get Paywall by Identifier
let paywall = await Apphud.paywall(ApphudPaywallID.onboarding.rawValue)

// Purchase product
// Purchase product from the paywall
let result = await Apphud.purchase(product)
```

## Topics

### Apphud main methods

- ``Apphud/start(apiKey:userID:observerMode:)``
- ``Apphud/paywalls``
- ``Apphud/start(apiKey:userID:observerMode:callback:)``
- ``Apphud/paywalls()``
- ``Apphud/placements()``
- ``Apphud/paywallsDidLoadCallback(_:)``
- ``Apphud/placementsDidLoadCallback(_:)``
- ``Apphud/purchase(_:callback:)``

- ``Apphud/willPurchaseProductFromPaywall(_:)``
Expand Down
9 changes: 9 additions & 0 deletions docs/css/chunk-c0335d80.10a2f091.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions docs/css/documentation-topic.1d1eec04.css

Large diffs are not rendered by default.

9 changes: 0 additions & 9 deletions docs/css/documentation-topic.3bca6578.css

This file was deleted.

9 changes: 9 additions & 0 deletions docs/css/documentation-topic~topic.b6287bcf.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

This file was deleted.

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/css/index.038e887c.css

Large diffs are not rendered by default.

9 changes: 0 additions & 9 deletions docs/css/index.12bb178a.css

This file was deleted.

9 changes: 9 additions & 0 deletions docs/css/topic.d8c126f3.css

Large diffs are not rendered by default.

9 changes: 0 additions & 9 deletions docs/css/topic.ee15af52.css

This file was deleted.

9 changes: 0 additions & 9 deletions docs/css/tutorials-overview.06e8bcf7.css

This file was deleted.

9 changes: 9 additions & 0 deletions docs/css/tutorials-overview.c249c765.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/apphudsdk.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/apphudsdk/apphud.json

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading

0 comments on commit 99951ae

Please sign in to comment.