Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rohankishore authored Oct 4, 2023
1 parent fe0c9cf commit 46de042
Showing 1 changed file with 43 additions and 2 deletions.
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,43 @@
# AnimeSnap
Unlock a world of anime information from a single scene screenshot – Including episode, timestamps, and much more!
<h1 align="center">⛩️ AnimeSnap 🍥</h1>

<div align="center">

<a href="https://opensource.org/licenses/MIT">![License](https://img.shields.io/badge/License-MIT-yellow)</a>
<a href="https://opensource.org/">![Language](https://img.shields.io/badge/Open-Source-blue)</a>
<a href="https://github.com/rohankishore/AnimeSnap/releases">![Demo](https://img.shields.io/badge/Download-Now-indigo)</a>
<a href="https://www.fiverr.com/rohancodespy/">![Demo](https://img.shields.io/badge/Fiverr-Hire-green)</a>
</div>

## 🍜 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).

<br>

This project is under MIT License.

0 comments on commit 46de042

Please sign in to comment.