docs: readme

This commit is contained in:
ThaUnknown 2025-06-29 17:53:24 +02:00
parent d032ae36d1
commit 6074dac1d5
No known key found for this signature in database

View file

@ -7,8 +7,6 @@
<h4 align="center"><b>Stream anime torrents instantly, real-time with no waiting for downloads to finish! 🍿</b></h4>
<p align="center">Formerly known as Miru.</p>
<p align="center">
<a href="https://hayase.watch/#about">About</a>
<a href="https://hayase.watch/features/">Features</a>
@ -24,6 +22,10 @@
</a>
</p>
<h4 align="center"><video src='https://raw.githubusercontent.com/hayase-app/website/main/docs/showcase.mp4' controls style='max-width: 80%'></h4>
<p align="center">Formerly known as Miru.</p>
## ✨ About
**Hayase** is a modern app for streaming anime torrents in real-time, with no waiting for downloads to finish.
@ -52,6 +54,10 @@ It is meant to feel look, work and perform like a premium streaming service, but
* Search by image, name, genre, year, season, and more.
* View trailers, OP/ED themes, and detailed episode lists with thumbnails, descriptions and filler indicators.
<p align="center">
<img src='https://raw.githubusercontent.com/hayase-app/website/main/static/viewanime.webp' style='max-width: 400px'></img>
</p>
### 🤝 Social & Community
* Instantly see which friends are following an anime or episode.
@ -90,6 +96,10 @@ It is meant to feel look, work and perform like a premium streaming service, but
* Exponential volume \[better control at lower volumes].
* External player support.
<p align="center">
<img src='https://raw.githubusercontent.com/hayase-app/website/main/static/videoplayer.webp' style='max-width: 400px'></img>
</p>
### 🧲 Torrents
* Stream torrents instantly, no waiting for full downloads.
@ -101,6 +111,10 @@ It is meant to feel look, work and perform like a premium streaming service, but
* Persist torrents, cache progress, and rescan instantly.
* View detailed torrent and peer info.
<p align="center">
<img src='https://raw.githubusercontent.com/hayase-app/website/main/static/modal.webp' style='max-width: 400px'></img>
</p>
### ⚙️ Performance & Security
* Highly secure.
@ -121,6 +135,10 @@ It is meant to feel look, work and perform like a premium streaming service, but
* In-app changelog.
* Custom themes.
<p align="center">
<img src='https://raw.githubusercontent.com/hayase-app/website/main/static/simple.webp' style='max-width: 400px'></img>
</p>
## **Building and Development**
Requires `Node 20` or above and `pnpm`. VSCode is recommended.