mirror of
https://github.com/Shineii86/MiruroAPI.git
synced 2026-10-22 10:15:10 +00:00
docs: update README, endpoints, streaming, and contributing docs
- Updated version to 2.3.3, endpoints 46→49, providers 12→14 - Added Direct Embed Providers section to README (megavid, anixo) - Updated streaming status table with embed alternative - Updated mermaid architecture diagram with embed flow - Updated health/stats sample responses with new fields - Added embed endpoint docs to docs/endpoints.md - Added Direct Embed section to docs/streaming.md - Updated CONTRIBUTING.md with embed provider notes - Added FAQ about direct embed providers - Updated roadmap with completed items
This commit is contained in:
+4
-1
@@ -30,7 +30,7 @@ npm run dev
|
||||
MiruroAPI/
|
||||
├── server.js # Express entry point
|
||||
├── src/
|
||||
│ ├── helpers/ # AniList, pipe, cache integrations
|
||||
│ ├── helpers/ # AniList, pipe + embed providers, cache integrations
|
||||
│ └── routes/ # Express routes
|
||||
├── public/ # Static files (landing page, Swagger UI)
|
||||
└── docs/ # API documentation
|
||||
@@ -43,6 +43,9 @@ MiruroAPI/
|
||||
3. Update `docs/endpoints.md` with documentation
|
||||
4. Test with `curl http://localhost:3000/api/your-endpoint`
|
||||
|
||||
> For streaming endpoints, consider adding direct embed providers (megavid, anixo)
|
||||
> in `src/helpers/pipe.js` — these bypass Cloudflare and work from any environment.
|
||||
|
||||
## Code Style
|
||||
|
||||
- Use CommonJS (`require`/`module.exports`)
|
||||
|
||||
Reference in New Issue
Block a user