From 46de04274636175ebe13feb4d81f286a3c4517d0 Mon Sep 17 00:00:00 2001
From: Rohan Kishore <109947257+rohankishore@users.noreply.github.com>
Date: Wed, 4 Oct 2023 23:22:30 +0530
Subject: [PATCH] Update README.md
---
README.md | 45 +++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 43 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 8313ce4..040766c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,43 @@
-# AnimeSnap
-Unlock a world of anime information from a single scene screenshot â Including episode, timestamps, and much more!
+
âŠī¸ AnimeSnap đĨ
+
+
+
+## đ What is AnimeSnap?
+AnimeSnap helps you to identify the anime episode or even timestamp just from a screenshot of any scene from that episode. It uses a powerful trace.moe API to find results. With just a screenshot, you can get:
+- The Anime name
+- The episode
+- The timestamps (start to end) where the scene from the screenshot is shown
+
+And much more if you export the results to JSON. It will also show multiple results with the percentage of accuracy.
+
+## đ Getting Started
+It is really easy to use. Head over to [Releases](https://github.com/rohankishore/AnimeSnap/releases), and download the exe file. AnimeSnap is currently available only to Windows machines.
+
+### Building on your own
+Download the `main.py` file from the repo, and follow the steps given below:
+- Install Pyinstaller [```pip install pyinstaller```]
+- Open the terminal and type: ```pyinstaller --onefile -w main.py```
+
+You can use `onedir` too.
+
+## đ Demo
+
+#### Sample Screenshot Image
+![sss](https://github.com/rohankishore/AnimeSnap/assets/109947257/b7facbe5-4af3-4f8a-af5d-f6c3f357b3e9)
+
+#### Output
+![image](https://github.com/rohankishore/AnimeSnap/assets/109947257/5ffc345b-10de-4080-98f4-1bf9ea5274d2)
+
+## Credits & License
+
+This project was made possible just because of [soruly](https://github.com/soruly)'s [trace.moe API](https://github.com/soruly/trace.moe-api).
+
+
+
+This project is under MIT License.