Readme & Information

Author: ippo-372

README 2.md

@@ -1,135 +1,4 @@
-## Sense - Android SDK
-
-Sense is a device intelligence and identification tool. This tool collects a comprehensive set of attributes unique to a device or browser, forming an identity that will help businesses.
-Requirements
-
-```
-* Use Android 5.1 (API level 21) and above.
-* Use Kotlin version 1.6.10 and above.
-* Add READ_PHONE_STATE Permission in Android Manifest for deivce information(Optional)
-```
-
-Note: If the application does not have the listed permissions, the values collected using those permissions will be ignored. To provide a valid device details, we recommend employing as much permission as possible based on your use-case.
-
-#### Step 1 - Add Dependency
-
-Add the dependency in the app level build.gradle:
-
-```
-dependencies {
-    implementation 'co.getsense:android:0.0.6'
-}
-```
-
-#### Step 2 - Import SDK
-
-```
-import co.getsense.android.Sense
-import co.getsense.android.SenseConfig
-```
-
-#### Step 3 - Initialize SDK
-
-Add the following line of code to initialize it with the api key you obtained from the Sense Client panel. If you don't have a api key create new one.
-
-```
-val config = SenseConfig(
-    apiKey = "Your API Key",
-    senseInfo = true, // true or false
-    allowGeoLocation = true, // true or false
-    tag = ""// Whatever you need, just mention the string here like home, contact, etc.
-)
-Sense.initSDK(activity, config)
-```
-
-#### Step 4 - Get Device Details
-
-Use the below code to get the Device Details
-
-```
-Sense.getSenseDetails(this)
-```
-
-#### Step 5 - Implement Listener
-
-Set and Implement our listener to receive the Callback details
-
-```
-Sense.getDeviceDetails(object : Sense.SenseListener {
-    override fun onSuccess(data: String) {
-        // success callback 
-    }
-    override fun onFailure(message: String) {
-        // failure callback
-    }
-})
-```
-
-#### Step 6 - Location Permission (Optional)
-
-````
-You have to add this permission in AndroidManifest.xml to get Device Location Information and to get Retrieve call state, Network state, Network information, Sim datas from READ_PHONE_STATE and READ_PRIVILEGED_PHONE_STATE.
-
-<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
-<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
-<uses-permission android:name="android.permission.READ_PHONE_STATE" />
-<uses-permission android:name="android.permission.READ_PRIVILEGED_PHONE_STATE"
-tools:ignore="ProtectedPermissions"/>
-
-````
-
-#### Step 7 - Progurad Rules (Optional)
-
-If you encounter any problem in your integration related to Proguard, you can use add the below lines Proguard Rules.
-
-```
--keep,allowobfuscation,allowshrinking interface retrofit2.Call
--keep,allowobfuscation,allowshrinking class retrofit2.Response
--keep,allowobfuscation,allowshrinking class kotlin.coroutines.** { *; }
--dontwarn co.getsense.**
--keep class co.getsense.** {*;}
-```
-
-#### Sample Program
-
-Here you can find the demonstration to do the integration.
-
-```
-import co.getsense.android.Sense
-import co.getsense.android.SenseConfig
-
-class MainActivity : AppCompatActivity() {
-    override fun onCreate(savedInstanceState: Bundle?) {
-        super.onCreate(savedInstanceState)
-        setContentView(R.layout.activity_main)
-
-        val config = SenseConfig(
-            apiKey = "Your API Key", //Replace with your Client Public API Key
-             senseInfo = true, // true or false
-             allowGeoLocation = true, // true or false
-             tag = ""// Whatever you need, just mention the string here like home, contact, etc.
-        )
-
-        //Initialize SDK
-        Sense.initSDK(this, config)
-
-        // Fetch device details
-        getDeviceDtails();
-    }
-    private fun getDeviceDtails() {
-        Sense.getDeviceDetails(object : Sense.SenseListener {
-            override fun onSuccess(data: String) {
-                // Handle success callback
-            }
-            override fun onFailure(message: String) {
-                // Handle failure callback
-            }
-        })
-    }
-}
-```
-
-# sense-device-identity
+# sense-user-activity-android
 <h1 align="center">Understanding User Intent : Sense</h1>
 
 <p align="center" width="100%">
@@ -179,31 +48,23 @@ notice how the visitor identifier remains the same in spite of all these changes
 
 #### MIT license : 
 
+Sense OS is available under the <a href="https://github.com/sense-opensource/sense-user-activity-android/blob/main/LICENSE"> MIT license </a>
+
 #### Contributors code of conduct : 
 
+Thank you for your interest in contributing to this project! We welcome all contributions and are excited to have you join our community. Please read these <a href="https://github.com/sense-opensource/sense-user-activity-android/blob/main/code_of_conduct.md"> code of conduct </a> to ensure a smooth collaboration.
+
 #### Where you can get support :     
 ![Gmail](https://img.shields.io/badge/Gmail-D14836?logo=gmail&logoColor=white)       product@getsense.co 
 
-#### Contributing guidelines :
-
-#### What's New : 
+Public Support:
 
-[02/24/2025]: Face parameters update  
-```
-We’ve trained the model for an increased accuracy of 94%.   
+For questions, bug reports, or feature requests, please use the Issues and Discussions sections on our repository. This helps the entire community benefit from shared knowledge and solutions.
 
-Here’s the installation steps : 
+Community Chat:
 
-1. Click on the download link  
-2. Download the model file and push it to the file directory  
-3. Run the file file  
-4. Restart the docker  
+Join our Discord server (link) to connect with other developers, ask questions in real-time, and share your feedback on Sense.
 
-```
-[08/27/2024]: User behavior added signals 
-```
-A new set of signals that track the user behaviour data has been 
-added to the code. These signals analyse the typing speed and the 
-duration between letter clicks on the keyboard 
+Interested in contributing to Sense?
 
-```
+Please review our <a href="https://github.com/sense-opensource/sense-user-activity-android/blob/main/CONTRIBUTING.md"> Contribution Guidelines </a> to learn how to get started, submit pull requests, or run the project locally. We encourage you to read these guidelines carefully before making any contributions. Your input helps us make Sense better for everyone!