Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #366

Open
wants to merge 18 commits into
base: dev
Choose a base branch
from
Open
77 changes: 64 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,92 @@

![banner](assets/banner.png)

<h1 align="center">
A FOSS <a href="https://anilist.co/">AniList</a> Only Client
</h1>

<p align="center">
<img src="https://pbxt.replicate.delivery/2PX94viD6lJSDVayQrGyDH7CGu7IjQ6e8HEtOGDeelefXRdOC/out.png" alt="Dantotsu Banner" width=100% >
Dantotsu (断トツ; Dan-totsu) "the best of the best". Try it out for yourself and be the judge!
</p>

<p align="center">
<img src="https://img.shields.io/badge/platforms-android-blueviolet?style=for-the-badge"/>
<a href="https://github.com/rebelonion/Dantotsu/releases"><img src="https://img.shields.io/github/downloads/rebelonion/Dantotsu/total?color=%233DDC84&logo=android&logoColor=%23fff&style=for-the-badge"></a>
<a href="https://www.codefactor.io/repository/github/rebelonion/dantotsu"><img src="https://www.codefactor.io/repository/github/rebelonion/dantotsu/badge?color=%233DDC84&logo=android&logoColor=%23fff&style=for-the-badge" alt="CodeFactor" /></a>
<a href="https://discord.gg/4HPZ5nAWwM"><img src="https://img.shields.io/discord/358599430502481920.svg?style=for-the-badge&logo=discord&colorB=7289DA"></a>
</p>

# **Dantotsu** 🌟
![screenshot](assets/dantotsu-screenshot.png)

Dantotsu is an [Anilist](https://anilist.co/) only client.
*Read this document in other languages: [English](README.md), [Spanish](docs/README.es.md) (You can contribute to add more)*

> **Dantotsu (断トツ; Dan-totsu)** literally means "the best of the best" in Japanese. Try it out for yourself and be the judge!
## 📋 FEATURES

<a href="https://www.buymeacoffee.com/rebelonion"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=rebelonion&button_colour=FFDD00&font_colour=030201&font_family=Poppins&outline_colour=000000&coffee_colour=ffffff" /></a>
- [x] Open Source
- [x] No Ads
- [x] AniList Sync
- [ ] Full AniList Client (WIP)
- [x] Themes
- [x] Extensions
- [x] Addons
- [x] Torrents
- [x] Downloads
- [x] Offline Mode
- [x] Incognito Mode
- [x] Configurable Player
- [x] Configurable Reader
- [x] Notifications
- [x] Widgets
- [x] Discord RPC
- [x] Backup Settings
- [x] Comment Section

### 🚀 STAR THIS REPOSITORY TO SUPPORT THE DEVELOPER AND ENCOURAGE THE DEVELOPMENT OF THE APPLICATION!

## WANT TO CONTRIBUTE? 🤝
## 💾 INSTALLATION AND UPDATES

All contributions are welcome, from code to documentation to graphics to design suggestions to bug reports. Please use GitHub to its fullest; contribute Pull Requests, contribute tutorials or other content - whatever you have to offer, we can use!
<a href="https://github.com/ImranR98/Obtainium/releases"><img src="https://github.com/andrew1412/Dantotsu/blob/dev/assets/badge_obtainium.png?raw=true" width=200px></a>

You can come hang out with our awesome community, request new features, and report any bugs or issues at our Discord server too. 📣
1. Download Obtainium from the badge above
2. In the `Add App` screen, add the following URL as the App Source: https://github.com/rebelonion/Dantotsu/
3. Toggle `Verify the 'latest' tag` and `Reconcile string with version detected from OS`
4. To recive Beta updates, enable `Include prereleases`
5. Enjoy!

### OFFICIAL DISCORD SERVER 🚀
## 🚧 ALPHA BUILDS

<p align="center">
If you want to help test the app you can do it with one (1) of the following methods

> [!warning]
> ALPHA IS FOR TEST ONLY, YOU MAY ENCOUNTER BUGS. IF YOU DO, OPEN AN ISSUE IN OUR GITHUB REPOSITORY OR IN THE DISCORD CHANNEL.

1. Download the `Dantotsu-Split` file from [Github Actions](https://github.com/rebelonion/Dantotsu/actions), unzipit and install the APK
2. Join the [Telegram](https://t.me/+gzBCQExtLQo1YTNh) group and install the APK
3. Join the [Discord](https://discord.gg/4HPZ5nAWwM) group and choose the `Pre Tester` role, go to the `Pretest APK` channel and install the APK
4. Add the following URL as the App Source on Obtainium: https://github.com/kaorlol/dantotsu-updater


## 🤝 WANT TO CONTRIBUTE?

All contributions are welcome: from code, documentation, graphics design, suggestions to bug reports. Please use GitHub to its fullest, whatever you have to offer, we can use it!


## ⭐ SUPPORT THE PROJECT
If you like Dantotsu, you're welcome to star this repository to support the developers and encourage further development of the application, don't forget to take part in the official Discord community.

<p align="left">
<a href="https://discord.gg/4HPZ5nAWwM">
<img src="https://invidget.switchblade.xyz/4HPZ5nAWwM">
</a>
</p>

## VISITORS
If you want to support Dantotsu's maintainer consider donating

<a href="https://www.buymeacoffee.com/rebelonion"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=rebelonion&button_colour=FFDD00&font_colour=030201&font_family=Poppins&outline_colour=000000&coffee_colour=ffffff" /></a>

## 👀 VISITORS

<img src="https://count.getloli.com/get/@:rebeloniondantotsu" alt=":rebeloniondantotsu" />

## LICENSE 📜
## 📜 LICENSE

Dantotsu is licensed under the [GNU General Public License v3.0](LICENSE.md)
Binary file added assets/badge_obtainium.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/dantotsu-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/get-it-on-github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
91 changes: 91 additions & 0 deletions docs/README.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
![banner](../assets/banner.png)

<h1 align="center">
Un Cliente de <a href="https://anilist.co/">AniList</a> FOSS
</h1>

<p align="center">
Dantotsu (断トツ; Dan-totsu) "lo mejor de lo mejor". Pruebalo y juzga tu mismo!
</p>

<p align="center">
<img src="https://img.shields.io/badge/platforms-android-blueviolet?style=for-the-badge"/>
<a href="https://github.com/rebelonion/Dantotsu/releases"><img src="https://img.shields.io/github/downloads/rebelonion/Dantotsu/total?color=%233DDC84&logo=android&logoColor=%23fff&style=for-the-badge"></a>
<a href="https://www.codefactor.io/repository/github/rebelonion/dantotsu"><img src="https://www.codefactor.io/repository/github/rebelonion/dantotsu/badge?color=%233DDC84&logo=android&logoColor=%23fff&style=for-the-badge" alt="CodeFactor" /></a>
<a href="https://discord.gg/4HPZ5nAWwM"><img src="https://img.shields.io/discord/358599430502481920.svg?style=for-the-badge&logo=discord&colorB=7289DA"></a>
</p>

![screenshot](../assets/dantotsu-screenshot.png)

*Lee este documento en otros idiomas: [Ingles](../README.md), [Español](docs/README.es.md) (Puedes contribuir para añadir mas)*

## 📋 CARACTERÍSTICAS

- [x] Open Source
- [x] Sin Ads
- [x] Sincronización con AniList
- [ ] Cliente Completo de AniList (WIP)
- [x] Temas
- [x] Extensiones
- [x] Addons
- [x] Torrents
- [x] Descargas
- [x] Modo Offline
- [x] Modo Incognito
- [x] Reproductor Configurable
- [x] Lector Configurable
- [x] Notificaciones
- [x] Widgets
- [x] Discord RPC
- [x] Backup de Ajustes
- [x] Sección de Comentarios


## 💾 INSTALACIÓN Y ACTUALIZACIONES

<a href="https://github.com/ImranR98/Obtainium/releases"><img src="https://github.com/andrew1412/Dantotsu/blob/dev/assets/badge_obtainium.png?raw=true" width=200px></a>

1. Descarga Obtainium desde la insignia de arriba
2. En `Añadir Aplicación`, añade la siguiente URL como origen de aplicación: https://github.com/rebelonion/Dantotsu/
3. Activa `Comprobar la etiqueta 'latest'` y `Usar la versión detectada por el SO`
4. Para recivir actualizaciónes Beta, activa `Incluir versiones preliminares`
5. Disfruta!

## 🚧 VERSIONES ALFA

Si quieres ayudar a probar la app puedes hacerlo con uno (1) de los siguientes metodos

> [!warning]
> ALFA ES SOLO PARA PRUEBAS, PODRIAS ENCONTRAR BUGS. SI LO HACES, ABRE UN ISSUE EN NUESTRO REPOSITORIO DE GITHUB O EN EL CANAL DE DISCORD.

1. descarga el archivo `Dantotsu-Split` desde [Github Actions](https://github.com/rebelonion/Dantotsu/actions), descomprimelo e instala la APK
2. Entral al grupo de [Telegram](https://t.me/+gzBCQExtLQo1YTNh) e instala la APK
3. Entral al grupo de [Discord](https://discord.gg/4HPZ5nAWwM) elige el rol de `Pre Tester`, ve al canal `Pretest APK` e instala la APK
5. Añade la siguiente URL como origen de aplicación en Obtainium: https://github.com/kaorlol/dantotsu-updater


## 🤝 ¿QUIERES CONTRIBUIR?

Todas las contribuciones son bienvenidas: desde código, documentación, diseño gráfico, sugerencias y hasta informes de errores. Por favor, usa GitHub al máximo, lo que sea que tengas para ofrecer, ¡podemos usarlo!


## ⭐ APOYA EL PROJECTO
Si te gusta Dantotsu, puede añadir a favoritos este repositorio para apoyar a los desarrolladores y alentar un mayor desarrollo de la aplicación, no olvide participar en la comunidad oficial de Discord.

<p align="left">
<a href="https://discord.gg/4HPZ5nAWwM">
<img src="https://invidget.switchblade.xyz/4HPZ5nAWwM">
</a>
</p>

Si deseas apoyar al mantenedor de Dantotsu, considera donarle

<a href="https://www.buymeacoffee.com/rebelonion"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=rebelonion&button_colour=FFDD00&font_colour=030201&font_family=Poppins&outline_colour=000000&coffee_colour=ffffff" /></a>

## 👀 VISITANTES

<img src="https://count.getloli.com/get/@:rebeloniondantotsu" alt=":rebeloniondantotsu" />

## 📜 LICENCIA

Dantotsu esta licenciado bajo [GNU General Public License v3.0](LICENSE.md)