Skip to content

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ThaUnknown committed Mar 20, 2024
1 parent 777794d commit 88d05a7
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 76 deletions.
46 changes: 19 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
<h1 align="center">
<p align="center">
<a href="https://github.com/ThaUnknown/miru">
<img src="./docs/logo.png" width="200">
<img src="./web/static/logo_filled.svg" width="200">
</a>
</h1>
</p>
<h1 align="center"><b>Miru</b></h1>

<h4 align="center"><b>Stream anime torrents, real-time with no waiting for downloads</b></h4>

<p align="center">
<a href="#about">About</a> •
<a href="#features">Features</a> •
<a href="./docs/faq.md">Frequently Asked Questions</a> •
<a href="https://miru.watch/#about">About</a> •
<a href="https://miru.watch/features/">Features</a> •
<a href="https://miru.watch/faq/">Frequently Asked Questions</a> •
<a href="#building-and-development">Building and Development</a> •
<a href="https://github.com/ThaUnknown/miru/releases/latest">Download</a>
<a href="https://miru.watch/download/">Download</a>
</p>
<p align="center">
<img src="./docs/show.gif" alt="chat"><br>
<video src="./docs/showcase.mp4" autoplay muted controls></video>
<br><br>
<a href="https://discord.gg/Z87Nh7c4Ac">
<img src="https://img.shields.io/discord/953341991134064651?style=flat-square" alt="chat">
</a>
<a href="https://github.com/ThaUnknown/miru/releases/latest">
<a href="https://miru.watch/download/">
<img alt="GitHub all releases" src="https://img.shields.io/github/downloads/ThaUnknown/miru/total?style=flat-square">
</a>

</p>

## **About**
Expand Down Expand Up @@ -52,8 +53,6 @@ Unlike qBit's sequential, seeking into undownloaded data will prioritise downloa
- support for VTT, SSA, ASS, SUB, TXT subtitles
- subtitle display in PiP
- keybinds for all functions:
- **,** - seek 1 frame backwards
- **.** - seek 1 frame forwards
- **S** - seek forwards 90 seconds [skip opening]
- **R** - seek backwards 90 seconds
- **** - seek forwards 2 seconds
Expand All @@ -63,6 +62,7 @@ Unlike qBit's sequential, seeking into undownloaded data will prioritise downloa
- **M** - mute volume
- **C** - cycle through subtitle tracks
- **N** - play next episode [if available]
- **B** - play last episode [if available]
- **F** - toggle fullscreen
- **P** - toggle picture in picture
- **[** - increase playback speed
Expand All @@ -87,6 +87,7 @@ Unlike qBit's sequential, seeking into undownloaded data will prioritise downloa
- support for custom torrent RSS feeds for latest releases
- change what resolution to find torrents in
- stream real-time with no waiting for downloads
- support for custom extensions for custom sources and trackers

## **Linux Installation**

Expand All @@ -113,21 +114,12 @@ apt install linux-Miru-*.deb

## **Building and Development**

*dont*

Dependencies:
- Node 16 or above
- PNPM

To build/develop, in the root folder of the repo you need to first run:
```bash
pnpm install
```

To build for your OS just run:
```bash
pnpm run build
```

To run the development server run:
```bash
pnpm start
```
- Docker
- Android Debug Bridge
- Java 18 or above [probably?]
- maybe others... have fun.
2 changes: 1 addition & 1 deletion common/views/Home/Home.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import { alToken, settings } from '@/modules/settings.js'
import { anilistClient, currentSeason, currentYear } from '@/modules/anilist.js'
const bannerData = anilistClient.search({ method: 'Search', sort: 'POPULARITY_DESC', perPage: 25, onList: false, season: currentSeason, year: currentYear })
const bannerData = anilistClient.search({ method: 'Search', sort: 'POPULARITY_DESC', perPage: 15, onList: false, season: currentSeason, year: currentYear })
const manager = new SectionsManager()
Expand Down
48 changes: 0 additions & 48 deletions docs/faq.md

This file was deleted.

Binary file removed docs/logo.png
Binary file not shown.
Binary file removed docs/show.gif
Binary file not shown.

0 comments on commit 88d05a7

Please sign in to comment.