From 516dbab8952559a248a6ddc97a4b491df9ac6361 Mon Sep 17 00:00:00 2001
From: abuthegr8 <abhinavgstar@gmail.com>
Date: Sat, 10 Jul 2021 19:45:55 +0530
Subject: [PATCH] [Docs] Add function details

---
 README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 52 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 297c086..f29f94c 100644
--- a/README.md
+++ b/README.md
@@ -37,4 +37,55 @@ logger.e(e,stacktrace); // Use StackTrace.current in case no stacktrace availabl
 
 ```
 logger.i("Api response: xyz");
-```
\ No newline at end of file
+```
+
+## Functions
+
+1. `Device_Info`: used to get details of device, namely:
+
+   - `brand`
+   - `manufacturer`
+   - `model`
+   - `os`
+   - `sdk`
+   - `id`
+   - `imei`
+   <br><br>
+   Also contains three subclasses:
+      - `IosDeviceInfoImpl`: For IOS devices
+      - `AndroidDeviceInfoImpl`: For Android devices
+      - `UnknownDeviceInfoImpl`: For other devices
+<br><br>
+
+2. `Package_Info`: used to get details of package and application, namely:
+
+   - `appName`
+   - `packageName`
+   - `version`
+   - `buildNumber`
+   <br><br>
+   `PackageInformationImpl` class defined here contains `getPackageInfo` function that returns all package and app details if detected platform:
+   `isMobile` or else returns "NA' in all fields.
+<br><br>
+
+3. `System_Info`: used to combine device and package details to get system details, namely:
+
+   - `version`
+   - `appName`
+   - `packageName`
+   - `buildNumber`
+   - `brand`
+   - `id`
+   - `manufacturer`
+   - `model`
+   - `os`
+   - `sdk`
+   - `imei`
+<br><br>
+
+4. `Platform_Utils`: used to check the platform on which the application is running. Platforms include:
+   - `Debug`
+   - `Mobile` (includes `Web`, `Android` and `IOS`)
+   - `Linux`
+   - `Mac`
+   - `Windows`