docs: fix README references to old endpoint count and caching

- Update endpoint count from 30 to 33 in badge, stats, and descriptions
- Update caching description from 5-min TTL to LRU with configurable TTL
- Update timeout description from 15s to configurable
- Update mermaid diagram labels
This commit is contained in:
Shinei Nouzen
2026-07-04 15:21:38 +05:30
parent 7641a81976
commit 5cf908fb1e
+10 -10
View File
@@ -20,13 +20,13 @@
<img src="https://img.shields.io/badge/Vercel-Serverless-000000?style=flat-square&logo=vercel&logoColor=white" alt="Vercel"/> <img src="https://img.shields.io/badge/Vercel-Serverless-000000?style=flat-square&logo=vercel&logoColor=white" alt="Vercel"/>
<img src="https://img.shields.io/badge/License-MIT-22c55e?style=flat-square&logo=mit&logoColor=white" alt="License"/> <img src="https://img.shields.io/badge/License-MIT-22c55e?style=flat-square&logo=mit&logoColor=white" alt="License"/>
<img src="https://img.shields.io/badge/Version-2.0.0-f43f8e?style=flat-square&logoColor=white" alt="Version"/> <img src="https://img.shields.io/badge/Version-2.0.0-f43f8e?style=flat-square&logoColor=white" alt="Version"/>
<img src="https://img.shields.io/badge/Endpoints-30-6366f1?style=flat-square&logoColor=white" alt="Endpoints"/> <img src="https://img.shields.io/badge/Endpoints-33-6366f1?style=flat-square&logoColor=white" alt="Endpoints"/>
<img src="https://img.shields.io/badge/Anime-10000+-a855f7?style=flat-square&logoColor=white" alt="Anime Database"/> <img src="https://img.shields.io/badge/Anime-10000+-a855f7?style=flat-square&logoColor=white" alt="Anime Database"/>
</p> </p>
<p align="center"> <p align="center">
<b>A complete RESTful API scraping real-time anime data from anikototv.to</b><br/> <b>A complete RESTful API scraping real-time anime data from anikototv.to</b><br/>
Search, browse, filter, watch — every endpoint returns live data with 5-minute smart caching.<br/> Search, browse, filter, watch — every endpoint returns live data with smart caching and multi-mirror fallback.<br/>
Built for building anime websites, apps, and bots. Built for building anime websites, apps, and bots.
</p> </p>
@@ -134,8 +134,8 @@ flowchart TD
### ⚡ Core ### ⚡ Core
- **Real-time scraping** from anikototv.to - **Real-time scraping** from anikototv.to
- **Smart caching** with 5-minute TTL - **Smart caching** with LRU and configurable TTL per endpoint
- **30 RESTful endpoints** covering all data - **33 RESTful endpoints** covering all data
- **AJAX episode loading** for accurate data - **AJAX episode loading** for accurate data
- **Mapper API integration** for extra servers - **Mapper API integration** for extra servers
- **Graceful error handling** per endpoint - **Graceful error handling** per endpoint
@@ -171,7 +171,7 @@ flowchart TD
- **CORS enabled** — works from any frontend - **CORS enabled** — works from any frontend
- **Error responses** with descriptive messages - **Error responses** with descriptive messages
- **Input validation** — required params checked - **Input validation** — required params checked
- **Timeout protection** — 15s per request - **Timeout protection** — Configurable per request
- **Multiple domains** — fallback mirror support - **Multiple domains** — fallback mirror support
- **Zero dependencies on databases** — pure scraping - **Zero dependencies on databases** — pure scraping
@@ -300,7 +300,7 @@ AniKotoAPI/
│ │ │ │
│ ├── 📂 docs/ # 📚 API documentation │ ├── 📂 docs/ # 📚 API documentation
│ │ ├── 📄 index.md # Overview, quick start │ │ ├── 📄 index.md # Overview, quick start
│ │ ├── 📄 endpoints.md # Full API reference (30 endpoints) │ │ ├── 📄 endpoints.md # Full API reference (33 endpoints)
│ │ ├── 📄 streaming.md # Streaming flow guide │ │ ├── 📄 streaming.md # Streaming flow guide
│ │ ├── 📄 examples.md # Code examples (cURL, JS, Python) │ │ ├── 📄 examples.md # Code examples (cURL, JS, Python)
│ │ └── 📄 architecture.md # Project structure, tech stack │ │ └── 📄 architecture.md # Project structure, tech stack
@@ -340,7 +340,7 @@ AniKotoAPI/
│ │ └── 📄 formatTitle.helper.js # 🔤 Title formatter │ │ └── 📄 formatTitle.helper.js # 🔤 Title formatter
│ │ │ │
│ └── 📂 routes/ # 🛤️ Express routes │ └── 📂 routes/ # 🛤️ Express routes
│ ├── 📄 apiRoutes.js # 🌐 Main API routes (30 endpoints) │ ├── 📄 apiRoutes.js # 🌐 Main API routes (33 endpoints)
│ └── 📄 category.route.js # 🏷️ Category routes │ └── 📄 category.route.js # 🏷️ Category routes
│ │
├── 📄 server.js # 🚀 Express server entry point ├── 📄 server.js # 🚀 Express server entry point
@@ -2044,7 +2044,7 @@ CMD ["node", "server.js"]
### Optimization Features ### Optimization Features
- 💾 **In-memory cache** — Map-based with TTL expiration - 💾 **LRU cache** — Configurable TTL per endpoint type
- ⚡ **Cheerio parsing** — Fast HTML DOM traversal - ⚡ **Cheerio parsing** — Fast HTML DOM traversal
- 🔧 **Custom headers** — Mimics browser requests - 🔧 **Custom headers** — Mimics browser requests
- 🎯 **Selective scraping** — Only extracts needed data - 🎯 **Selective scraping** — Only extracts needed data
@@ -2168,7 +2168,7 @@ The API can access 10,000+ anime titles from anikototv.to. The most-popular endp
### ✅ Completed ### ✅ Completed
- [x] 🎬 30 API endpoints covering all data - [x] 🎬 33 API endpoints covering all data
- [x] 🔍 Full-text search with pagination - [x] 🔍 Full-text search with pagination
- [x] 📺 Episode lists via AJAX loading - [x] 📺 Episode lists via AJAX loading
- [x] 🎯 Advanced filtering (genre, type, status, rating, sort) - [x] 🎯 Advanced filtering (genre, type, status, rating, sort)
@@ -2176,7 +2176,7 @@ The API can access 10,000+ anime titles from anikototv.to. The most-popular endp
- [x] 🎲 Random anime discovery - [x] 🎲 Random anime discovery
- [x] 📡 Streaming server info + mapper API - [x] 📡 Streaming server info + mapper API
- [x] 📋 AZ List alphabetical browsing - [x] 📋 AZ List alphabetical browsing
- [x] 🔄 Smart caching with 5-min TTL - [x] 🔄 Smart caching with LRU and configurable TTL
- [x] 🚀 One-click Vercel deployment - [x] 🚀 One-click Vercel deployment
- [x] 📖 Comprehensive documentation with real API data - [x] 📖 Comprehensive documentation with real API data
- [x] 🏗️ AlisaReactionBot-style code comments - [x] 🏗️ AlisaReactionBot-style code comments