Update README.md
This commit is contained in:
53
README.md
53
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.*`)
|
### 1. System API (`pawletos.device.system`)
|
||||||
- API to check if running on PawletOS
|
|
||||||
- Access to branding, codename, welcome message
|
Intended for **system apps**.
|
||||||
- Designed for apps and system code to import via:
|
|
||||||
```java
|
Provides access to:
|
||||||
import pawlet.oxmc.OxmcEnvironment;
|
|
||||||
|
* 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();
|
||||||
|
```
|
Reference in New Issue
Block a user