From 6e81be5cbd27f1318b6523afa115fae27c645f57 Mon Sep 17 00:00:00 2001
From: Udhayarajan <77388817+Udhayarajan@users.noreply.github.com>
Date: Fri, 27 Jan 2023 12:18:05 +0530
Subject: [PATCH] Update README.md

---
 README.md | 67 ++++++++++++++++++++++++++++++++++++++-----------------
 1 file changed, 46 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index bfc496ae..b57393e1 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,54 @@
-# VidSnapKit-Ultimate
-Same as VidSnapKit but multi-platform project with JVM jar an android aar support. Social media post downloading library wriiten in Kotlin for Android and JVM machines. Compatible with Java projects too.
+# VidSnapKit
+VidSnapKit is a Kotlin Multi-Platform library that allows users to download videos from Instagram (Reels, Stories, Carousel Posts), Facebook, DailyMotion, LinkedIn, ShareChat, and Vimeo. The library is built with support for Android and JVM, and can be easily included in other Java/Kotlin projects or Android apps.
 
-Add below lines to your gradle file.
+## Installation
+Add the following dependency to your app's build.gradle file:
 
-    dependencies {
-        ...
-        implementation 'io.github.udhayarajan:VidSnapKit:<LATEST_VERSION>'
-    }
-    
-You can see `LATEST_VERSION` from release of this current respository.
 
-NOTE: You no need to add beta `v` and `beta` tag in implementaion line. Just add numerical version alone (eg: `v2.0.1-beta` as  `implementation 'io.github.udhayarajan:VidSnapKit:2.0.1`)
+    implementation 'io.github.udhayarajan:VidSnapKit:<release_version>'
 
-Also make sure to include `mavenCentral()` repository
+You can see LATEST_VERSION from release of this current respository.
 
+NOTE: You no need to add `v` and `beta` tag in implementaion line. Just add numerical version alone (eg: v2.0.1-beta as implementation `'io.github.udhayarajan:VidSnapKit:2.0.1'`)
 
-    repositories {
-        mavenCentral()
-    }
+Sync your project with Gradle.
 
 
-## Supported:
- - Instagram(Reels, Stories, Carousel Post, Image Post)
- - Facebook
- - DailyMotion
- - LinkedIn
- - ShareChat
- - Vimeo
+## Usage
+To download a video, call the downloadVideo function with the URL of the video and the platform it is from (Instagram, Facebook, DailyMotion, LinkedIn, ShareChat, or Vimeo) and cookies if applicable.
+
+
+    val extractor = Extractor.findExtractor("https://www.instagram.com/p/B_5qXN6j5sd")
+    extractor?.let {
+                    cookies?.let { cookie ->
+                        it.cookies = cookie
+                    }
+                    it.start { res ->
+                        //Get data from here
+                    }
+                }
+The function will return a Extractor object representing the extracted video.
+
+## Note
+- Make sure you have the necessary permissions to download the video.
+- The library is intended for personal use only and should not be used for copyright infringement.
+- The library is for educational and testing purposes and is not intended for commercial use.
+
+## Contributing
+If you want to contribute to this project, feel free to open a pull request or create an issue.
+
+## Support
+If you have any issues or questions, please open an issue.
+
+## License
+This project is licensed under the Apache 2.0 License.
+
+## Author
+This project is created by [Udhayarajan M](https://linktr.ee/udhayarajan_m)
+
+## Resources
+A sample app using this library can be found at this URL: https://github.com/Udhayarajan/VidSnapKit/tree/master/sample%20app
+
+## Additional things
+You can check the sample app for more details on how to use this library
+Cookies can be applied if applicable.