Merge pull request #2 from dk-a-dev/master

Ready for release

Author: dk-a-dev

.gitignore

@@ -13,3 +13,4 @@
 .externalNativeBuild
 .cxx
 local.properties
+.vscode

.idea/deploymentTargetDropDown.xml

@@ -2,59 +2,107 @@
 <a href="https://dscvit.com">
 	<img width="400" src="https://user-images.githubusercontent.com/56252312/159312411-58410727-3933-4224-b43e-4e9b627838a3.png#gh-light-mode-only" alt="GDSC VIT"/>
 </a>
-	<h2 align="center"> < Insert Project Title Here > </h2>
-	<h4 align="center"> < Insert Project Description Here > <h4>
-</p>
-
----
-[![Join Us](https://img.shields.io/badge/Join%20Us-Developer%20Student%20Clubs-red)](https://dsc.community.dev/vellore-institute-of-technology/)
-[![Discord Chat](https://img.shields.io/discord/760928671698649098.svg)](https://discord.gg/498KVdSKWR)
-
-[![DOCS](https://img.shields.io/badge/Documentation-see%20docs-green?style=flat-square&logo=appveyor)](INSERT_LINK_FOR_DOCS_HERE) 
-  [![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](INSERT_UI_LINK_HERE)
-
-
-## Features
-- [ ]  < feature >
-- [ ]  < feature >
-- [ ]  < feature >
-- [ ]  < feature >
+	<h2 align="center">Liwid</h2>
+	<h4 align="center">Liwid is an Android Library designed to simplify the integration of dynamic and customisable widgets on the lock screen. 
+It uses sophisticated notification integration, placing widgets as notifications on the lock screen. 
+This approach grants users immediate access to the dynamic content from their lock screen, transforming their experience
+</h4>
 
-<br>
+## Table of Contents
+- [Key Features](#key-features)
+- [Configure](#configure)
+- [Usage](#usage)
+- [Contributors](#contributors)
 
-## Dependencies
- - < dependency >
- - < dependency >
+## Key Features
+- [x] Dynamic and Customisable Widgets: Effortlessly integrate customisable and dynamic widgets, enhancing your Android applications.
+- [x] Error Handling: handle errors and exceptions gracefully.
+- [ ] Custom UI: Easily customize the look and feel of the widget as per your app requirements.
+- [ ] Support to more types of widgets: Currently, it supports tracking and sports type widgets, and can be extended to add more widgets in the future.
 
+  <br>
 
-## Running
+## Configure
+### Gradle
+Add the following to your project level root `build.gradle`:
+```gradle
+allprojects {
+    repositories {
+        ...
+        maven { url "https://jitpack.io" }
+    }
+}
+```
+Add the dependency:
+```gradle
+dependencies {
+    implementation 'com.github.GDGVIT:Liwid:1.0.0'
+}
+```
 
+User permissions required:
+```xml
+<manifest>
+    <uses-permission android:name="android.permission.INTERNET"/>
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+.
+.
+</manifest>
+```
 
-< directions to install > 
-```bash
-< insert code >
+## Usage
+### Changing the notification channel
+```kotlin
+fun createCustomChannel(context: Context, activity: Activity) {
+  val liveWidget = LiveWidget(context = context, activity = activity, widgetType = LiveWidget.WidgetType.SPORTS)
+// Configure channel settings
+  liveWidget.configureChannel(
+    id = "Custom_Channel_Id",
+    name = "Custom Channel Name",
+    description = "Custom Channel Description"
+  )
+}
 ```
 
-< directions to execute >
+### Specifying the API attributes as per widget
+```kotlin
+fun startSportsWidgetService(context: Any) {
+    LiveSportsWidget.create(
+        context = context,
+        activity = context as Activity,
+        baseUrl = BASE_URL,
+        endpoint = GAME_TYPE,
+        params = mapOf(
+            "met" to MATCH_TYPE,
+            "APIkey" to API_KEY,
+            "leagueID" to league_id,
+        )
+    )
+}
+```
 
-```bash
-< insert code >
+### Stopping the widget service
+```kotlin
+GlobalScope.launch {
+    LiveSportsWidget.stopSportsWidget()
+}
 ```
 
 ## Contributors
-
 <table>
 	<tr align="center">
 		<td>
-		John Doe
+		Dev Keshwani
 		<p align="center">
-			<img src = "https://dscvit.com/images/dsc-logo-square.svg" width="150" height="150" alt="Your Name Here (Insert Your Image Link In Src">
+			<img src = "https://avatars.githubusercontent.com/u/84137299?s=400&u=706239e377f631a79fc68c59c73370c9503d6b44&v=4" width="150" height="150" alt="Your Name Here (Insert Your Image Link In Src">
 		</p>
 			<p align="center">
-				<a href = "https://github.com/person1">
+				<a href = "https://github.com/dk-a-dev">
 					<img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/>
 				</a>
-				<a href = "https://www.linkedin.com/in/person1">
+				<a href = "https://www.linkedin.com/in/dev-keshwani-38958a21a/">
 					<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
 				</a>
 			</p>

.idea/gradle.xml

@@ -4,11 +4,11 @@ plugins {
 }
 
 android {
-    namespace 'com.liwid.liwid_extension'
+    namespace 'com.liwid.example'
     compileSdk 34
 
     defaultConfig {
-        applicationId "com.liwid.liwid_extension"
+        applicationId "com.liwid.example"
         minSdk 24
         targetSdk 34
         versionCode 1
@@ -37,12 +37,11 @@ android {
     kotlinOptions {
         jvmTarget = '1.8'
     }
+    composeOptions {
+        kotlinCompilerExtensionVersion '1.5.7'
+    }
     buildFeatures {
         compose true
-        buildConfig=true
-    }
-    composeOptions {
-        kotlinCompilerExtensionVersion '1.5.6'
     }
     packagingOptions {
         resources {
@@ -56,23 +55,18 @@ dependencies {
     implementation 'androidx.core:core-ktx:1.12.0'
     implementation platform('org.jetbrains.kotlin:kotlin-bom:1.8.0')
     implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.6.2'
+    implementation 'androidx.compose.material3:material3'
     implementation 'androidx.activity:activity-compose:1.8.2'
     implementation platform('androidx.compose:compose-bom:2022.10.00')
     implementation 'androidx.compose.ui:ui'
     implementation 'androidx.compose.ui:ui-graphics'
     implementation 'androidx.compose.ui:ui-tooling-preview'
-    implementation 'androidx.compose.material3:material3'
-    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
-    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
-    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0-RC'
-    implementation 'androidx.cardview:cardview:1.0.0'
-    implementation 'com.github.bumptech.glide:glide:4.12.0'
-    annotationProcessor 'com.github.bumptech.glide:compiler:4.12.0'
     testImplementation 'junit:junit:4.13.2'
     androidTestImplementation 'androidx.test.ext:junit:1.1.5'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
     androidTestImplementation platform('androidx.compose:compose-bom:2022.10.00')
     androidTestImplementation 'androidx.compose.ui:ui-test-junit4'
     debugImplementation 'androidx.compose.ui:ui-tooling'
     debugImplementation 'androidx.compose.ui:ui-test-manifest'
+    implementation project(':liwid')
 }

.idea/migrations.xml

@@ -1,4 +1,4 @@
-package com.liwid.liwid_extension
+package com.liwid.example
 
 import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4

.idea/misc.xml

@@ -5,28 +5,26 @@
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC"/>
     <application
         android:allowBackup="true"
         android:dataExtractionRules="@xml/data_extraction_rules"
         android:fullBackupContent="@xml/backup_rules"
         android:icon="@mipmap/ic_launcher"
-        android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/Theme.Liwidapp"
         tools:targetApi="31">
         <activity
-            android:name=".example.MainActivity"
+            android:name="MainActivity"
             android:exported="true"
-            android:label="@string/app_name"
             android:theme="@style/Theme.Liwidapp">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
-        <receiver android:name=".NotificationActionReceiver" />
-        <service android:name=".example.ForegroundService"/>
+        <service android:name="com.dscvit.liwid.WidgetForegroundService" android:foregroundServiceType="dataSync"/>
     </application>
 
 </manifest>