diff --git a/README.md b/README.md index c8dfc0e..9f43b1b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,47 @@ -# OxmcEnvironment Framework API +# PawletOS Framework API -This repository contains the PawletOS framework API under `pawletos.oxmc`. +This repository contains the **PawletOS framework APIs**, providing both system-level and device-level functionality for apps running on PawletOS builds. -## Features +## Modules -- System property access (`ro.oxmc.build.*`) -- API to check if running on PawletOS -- Access to branding, codename, welcome message -- Designed for apps and system code to import via: - ```java - import pawlet.oxmc.OxmcEnvironment; \ No newline at end of file +### 1. System API (`pawletos.device.system`) + +Intended for **system apps**. + +Provides access to: + +* Emulator detection +* Root status checks +* PawletOS detection +* Pawlet SDK version +* Locale information + +Example usage in a system app: + +```java +import pawletos.device.system.PawletSystem; + +boolean isEmulator = PawletSystem.isEmulator(); +double sdkVersion = PawletSystem.getPawletSDKVersion(); +``` + +--- + +### 2. Device API (`pawletos.device`) + +Intended for **user apps**. + +Provides access to device-specific information: + +* Brand and codename +* Custom build properties (`ro.pawlet.build.*`) +* Manufacture date, series, warranty info + +Example usage in a user app: + +```java +import pawletos.device.PawletDevice; + +String brand = PawletDevice.getBrandName(context); +String series = PawletDevice.getSeries(); +``` \ No newline at end of file