Skip to content

Commit 8d2a80d

Browse files
docs: add Entitlements & Admin Portal to README (#81)
* docs: add Entitlements & Admin Portal to README; dedupe Native SDK versions Surface the two capabilities wired in #78 (entitlements + admin portal) on the README landing page, linking to the usage/advanced guides, and remove the duplicated 'Native SDK versions' section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: fix 'scenarIonic' typo in README Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 8c5b301 commit 8d2a80d

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

docs/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,20 @@ This repository includes:
1414
- A [Get Started](https://ionic-capacitor-guide.frontegg.com/#/getting-started) guide for quick integration
1515
- A [Setup Guide](https://ionic-capacitor-guide.frontegg.com/#/setup) with detailed setup instructions
1616
- [Usage Examples](https://ionic-capacitor-guide.frontegg.com/#/usage) with common implementation patterns
17-
- [Advanced Topics](https://ionic-capacitor-guide.frontegg.com/#/advanced) for complex integration scenarIonic
17+
- [Advanced Topics](https://ionic-capacitor-guide.frontegg.com/#/advanced) for complex integration scenarios
1818
- A [Embedded](https://github.com/frontegg/frontegg-ionic-capacitor/tree/master/example) example projects to help you get started quickly
1919

2020
For full documentation, visit the Frontegg Developer Portal:
2121
🔗 [https://developers.frontegg.com](https://developers.frontegg.com)
2222

2323
---
2424

25-
## 🔐 Native SDK versions
26-
27-
The Ionic Capacitor wrapper depends on the underlying native SDKs:
25+
## 🧩 Entitlements & Admin Portal
2826

29-
- On **Android**, the plugin and example app use `com.frontegg.sdk:android:1.3.34`.
30-
- On **iOS**, the plugin depends on `FronteggSwift` **1.3.10** via CocoaPods.
27+
The wrapper bridges two native capabilities into your Ionic app:
3128

32-
After upgrading, run `pod install` in your iOS project and rebuild both platforms.
29+
- **Entitlements** — gate features and permissions on-device with `loadEntitlements()`, `getFeatureEntitlement({ key })`, and `getPermissionEntitlement({ key })` (each resolves to `{ isEntitled, justification }`). See the [Entitlements guide](https://github.com/frontegg/frontegg-ionic-capacitor/blob/master/docs/usage.md#entitlements).
30+
- **Admin Portal** — open the embedded Frontegg Admin Portal for authenticated users with `openAdminPortal()`. It opens through the native iOS/Android token bridge, so users aren't prompted to log in again. See the [Admin Portal guide](https://github.com/frontegg/frontegg-ionic-capacitor/blob/master/docs/advanced.md#admin-portal-beta).
3331

3432
---
3533

0 commit comments

Comments
 (0)