added readme

This commit is contained in:
Ara0n 2022-02-20 14:42:22 +05:30
parent 693613b878
commit 6f2876aa58

View File

@ -1,9 +1,39 @@
<img src="https://raw.githubusercontent.com/Araon/Araon_chan/master/docs/anime.png?token=GHSAT0AAAAAABNS4OMWZXI5TCVEO62GMA3SYQ3H4AQ" width="250" height="250">
# Araon-Chan
###### A Telegram bot to send anime directly to your inbox
## About <a name = "about"></a>
Telegram bot to search and download anime from various websites.
## [Architecture](https://github.com/Araon/Araon_chan/blob/master/docs/architechture.md)
## [Database](https://github.com/Araon/Araon_chan/blob/master/docs/databaseSchema.md)
###Websites used
Website | Quality | Status
------------- | ------------- | ------------
9Animel | 720p, 1080p | ✔️
AllAnime | 720p, 1080p | ✔️
AnimePahe | 720p, 1080p | ✔️
AnimeOut | 720p, 1080p | ❌
Animixplay | 480p, 720p, 1080p | ✔️
Animtime | 720p, 1080p | ✔️
Crunchyroll | 720p, 1080p | ✔️
Kawaiifu (NSFW) | 720p, 1080p | ❌
GogoAnime | 720p, 1080p | ✔️
Haho (NSFW) | 720p, 1080p | ✔️
Tenshi | 720p, 1080p | ✔️
Twist | 720p, 1080p | ✔️
Zoro | 720p, 1080p | ✔️
###To-do List
- [x] Add Mongodb for better response time
- [ ] Precache popular trending animes to database
- [ ] Add subscription feature
- [ ] Moar Bug fixes
- [ ] Add support for linux
- [ ] Change file path
#### Status
Still under development :tw-1f528: