@@ -42,7 +42,7 @@ class MyApplication : Application() {
4242 override fun onCreate () {
4343 super .onCreate()
4444
45- val config = SdkConfig .Builder (" your-api-key " )
45+ val config = SdkConfig .Builder (123456 ) // Your MaxMind account ID
4646 .enableLogging(BuildConfig .DEBUG )
4747 .build()
4848
@@ -98,27 +98,27 @@ Collect device data without sending:
9898
9999``` kotlin
100100val deviceData = DeviceTracker .getInstance().collectDeviceData()
101- println (" Device: ${deviceData.manufacturer} ${deviceData.model} " )
101+ println (" Device: ${deviceData.build. manufacturer} ${deviceData.build .model} " )
102102```
103103
104104## Configuration Options
105105
106106### SdkConfig.Builder
107107
108108``` kotlin
109- val config = SdkConfig .Builder (" your-api-key " )
109+ val config = SdkConfig .Builder (123456 ) // Your MaxMind account ID
110110 .serverUrl(" https://custom-server.com/api" ) // Optional: Custom server URL
111111 .enableLogging(true ) // Optional: Enable debug logging
112112 .collectionInterval(60_000 ) // Optional: Auto-collect every 60 seconds
113113 .build()
114114```
115115
116- | Option | Type | Default | Description |
117- | --------| ------| ---------| -------------|
118- | ` apiKey ` | String | * required * | Your MaxMind API key |
119- | ` serverUrl ` | String | ` https://device-api.maxmind.com/v1 ` | MaxMind API endpoint |
120- | ` enableLogging ` | Boolean | ` false ` | Enable debug logging |
121- | ` collectionIntervalMs ` | Long | ` 0 ` | Auto-collection interval (0 = disabled) |
116+ | Builder Method | Type | Default | Description |
117+ | ------------------------- | ------- | --------------- | ------------------------------------------------------- |
118+ | ` Builder(accountID) ` | Int | _ required _ | Your MaxMind account ID |
119+ | ` . serverUrl(url) ` | String | Default servers | Custom server URL |
120+ | ` . enableLogging(enabled) ` | Boolean | ` false ` | Enable debug logging |
121+ | ` .collectionInterval(ms) ` | Long | ` 0 ` | Auto-collection interval in milliseconds (0 = disabled) |
122122
123123## Permissions
124124
@@ -129,22 +129,6 @@ The SDK requires the following permissions (automatically included):
129129<uses-permission android : name =" android.permission.ACCESS_NETWORK_STATE" />
130130```
131131
132- ## Collected Data
133-
134- The SDK collects the following device information:
135-
136- - ** Device ID** : Optional unique identifier
137- - ** Manufacturer** : Device manufacturer (e.g., "Samsung", "Google")
138- - ** Model** : Device model name
139- - ** Brand** : Device brand name
140- - ** OS Version** : Android version
141- - ** SDK Version** : Android SDK/API level
142- - ** Screen Resolution** : Display resolution
143- - ** Screen Density** : Display density
144- - ** Timestamp** : Collection timestamp
145-
146- All data collection respects user privacy and Android security policies.
147-
148132## ProGuard / R8
149133
150134The SDK includes consumer ProGuard rules. No additional configuration is needed.
@@ -237,16 +221,8 @@ at your option. Copyright 2025 MaxMind, Inc.
237221
238222## Support
239223
240- 241- - Issues: [ GitHub Issues] ( https://github.com/maxmind/device-android/issues )
242- - Docs: [ API Documentation] ( https://maxmind.github.io/device-android/ )
243-
244- ## Changelog
245-
246- ### 0.1.0-SNAPSHOT (2025-10-28)
224+ For support, please visit
225+ [ maxmind.com/en/company/contact-us] ( https://www.maxmind.com/en/company/contact-us ) .
247226
248- - Initial release
249- - Basic device data collection
250- - HTTP API integration
251- - Automatic collection intervals
252- - Java compatibility
227+ If you find a bug or have a feature request, please open an issue on
228+ [ GitHub] ( https://github.com/maxmind/device-android/issues ) .
0 commit comments