Skip to content

Commit

Permalink
Merge pull request #182 from Miruro-no-kuon/preview-main
Browse files Browse the repository at this point in the history
readme-patch update
  • Loading branch information
trying559 authored Mar 30, 2024
2 parents dcef988 + 9fb6988 commit 5044236
Showing 1 changed file with 51 additions and 39 deletions.
90 changes: 51 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
<h1 align="center">
MIRURO
</h1>

<p align="center">
<a href="https://www.miruro.com" target="_blank">
<img src="https://raw.githubusercontent.com/Miruro-no-kuon/Miruro/main/src/assets/miruro-transparent-white.png" alt="Logo" width="200"/>
</a>
</p>

<h1 align="center">
<a href="https://www.miruro.com">miruro.com</a> //
<a href="https://www.miruro.com">miruro.com</a> |
<a href="https://www.miruro.tv">miruro.tv</a>
<p align="center">
<img src="https://discordapp.com/api/guilds/1199699127190167643/widget.png?style=shield" alt="Discord Shield"/>
Expand All @@ -22,41 +26,50 @@

## What is Miruro?

<p><a href="https://www.miruro.com">Miruro</a> is a anime streaming platform powered by the <a href="https://github.com/consumet">Consumet API</a>. Crafted using <a href="https://react.dev/">React</a> and <a href="https://vitejs.dev/">Vite</a>, it boasts a stylish and contemporary interface. Miruro.com offers an immersive anime streaming experience where you can enjoy a vast library of anime titles in HD. Watch your favorite shows with English subtitles or dubbing, and conveniently download any anime without the need for registration.</p>
Welcome to **Miruro** - your ultimate anime destination! 😎 Explore **[miruro.com](https://www.miruro.com)** and dive into the world of anime, powered by the incredible **[Consumet API](https://github.com/consumet)**.

Crafted with using **React** and **Vite**, our site rocks a slick and modern interface. Experience lightning-fast performance and smooth navigation as you explore a vast collection of HD anime titles.

Enjoy your favorite shows with English subs or dubs, and here's the kicker - you can download individual episodes hassle-free, no sign-up required!

## Features 🪴

- General
- Dub Anime support
- User-friendly interface
- Mobile responsive
- Fast page load
- White/Dark theme
- Continue watching section
- Watch Page
- Player
- Autoplay next episode
- Skip op/ed button
- Theater mode
- Coming Soon
- Profile page to see your watch list
- Comment section
- Anilist/MAL login integration
<details>
<summary>View More</summary>

<div style="text-align: left;">
<h3>Home Page</h3>
### General

- Dub Anime support
- User-friendly interface
- Mobile responsive
- Fast page load
- White/Dark theme
- Continue watching section

### Watch Page

- **Player**
- Autoplay next episode
- Skip op/ed button
- Theater mode

### Coming Soon

- Profile page to see your watch list
- Comment section
- Anilist/MAL login integration

</details>

## Images

<div style="text-align: left;">
<img src="https://raw.githubusercontent.com/Miruro-no-kuon/.github/main/profile/home-page.webp" alt="Home Page" style="max-width: 70%;" >
<details>
<summary>View More</summary>
<h3>Splash Page</h3>
<br>
<img src="https://raw.githubusercontent.com/Miruro-no-kuon/.github/main/profile/splash-page.webp" alt="Splash Page" style="max-width: 70%;">

<h3>Watch Page</h3>
<img src="https://raw.githubusercontent.com/Miruro-no-kuon/.github/main/profile/watch-page.webp" alt="Watch Page" style="max-width: 70%;">

<h3>Footer</h3>
<img src="https://raw.githubusercontent.com/Miruro-no-kuon/.github/main/profile/footer.webp" alt="Footer" style="max-width: 70%;">
</details>
</div>
Expand Down Expand Up @@ -122,40 +135,39 @@ bun start

Please be aware that self-hosting this application is strictly limited to personal use only. Commercial utilization is prohibited, and the inclusion of advertisements on your self-hosted website may lead to consequences, including potential site takedown measures.

## For Deployments

#### Deploy your Miruro instance on Vercel:
#### Deploy your own Miruro Instance

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgit.luolix.top%2FMiruro-no-kuon%2FMiruro&env=VITE_BACKEND_URL,VITE_PROXY_URL,VITE_IS_LOCAL,PORT&project-name=miruro&repository-name=miruro)

https://github.com/Miruro-no-kuon/Miruro/assets/77152696/98b95343-a15b-4302-92ee-e4910860887e

## License 📝

This project is licensed under the Custom BY-NC [License](LICENSE). You are free to use, share, and modify the code for non-commercial purposes with proper attribution to our platform miruro.com. Commercial use is not allowed. For details, see the [LICENSE](LICENSE) file. Feel free to contact the author(s) for questions or additional permissions.
Hey there! Just so you know, this project follows a Custom BY-NC License. What does that mean? Well, you're welcome to use, share, and tinker with the code as long as it's for non-commercial purposes. Oh, and don't forget to give credit to our platform, [miruro.com](https://www.miruro.com). If you're thinking of using it for commercial stuff, sorry, that's a no-go. For all the details, check out the [LICENSE](LICENSE) file. Got questions or need special permissions? Feel free to shoot us a message!

## Bug Report 🐞
## Found a Bug? 🐞

If you encounter any issues or bug on the site please head to [issues](https://github.com/Miruro-no-kuon/Miruro-no-Kuon/issues) and create a bug report there.
Uh-oh, looks like you stumbled upon a bug? No worries, we're here to squash it! Just head over to our [issues](https://github.com/Miruro-no-kuon/Miruro-no-Kuon/issues) section on GitHub and let us know what's up.

## Contact 📧
## Get in Touch! 📧

If you have any questions or feedback, please reach out to us at [miruro@proton.me](mailto:miruro@proton.me), or you can join our [Discord Sever](https://discord.com/invite/4kfypZ96K4).
Got questions, suggestions, or just wanna say hi? Drop us a line at miruro@proton.me. You can also hang out with us on Discord.

- Visit our website at **[miruro.com](https://www.miruro.com)**
- Visit our website at **[Miruro.com](https://www.miruro.com)**

- Follow us on **[Twitter](https://twitter.com/miruro_official)**

- Join our **[Subreddit](https://www.reddit.com/r/miruro)**

- Join our **[Discord](https://discord.gg/4kfypZ96K4)**

<a href="https://discord.com/invite/4kfypZ96K4">

![Discord Banner 2](https://discordapp.com/api/guilds/1199699127190167643/widget.png?style=banner2)
</a>
[![Discord Banner 2](https://discordapp.com/api/guilds/1199699127190167643/widget.png?style=banner2)](https://discord.com/invite/4kfypZ96K4)

## Support & Contributions 🤲

⭐️ [Star this project](https://github.com/Miruro-no-kuon/Miruro) ⭐️
#### [Star this project](https://github.com/Miruro-no-kuon/Miruro) ⭐️

#### Want to Help Out?

Feel free to contribute to this project! Whether you're an experienced developer or have been in the field for a while, your help is valuable.

Expand Down

0 comments on commit 5044236

Please sign in to comment.