diff --git a/README.md b/README.md index f911bcff83..471dcb9347 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ + +![banner](assets/banner.png) + +

+A FOSS AniList Only Client +

+

- Dantotsu Banner +Dantotsu (断トツ; Dan-totsu) "the best of the best". Try it out for yourself and be the judge!

+

@@ -8,34 +16,77 @@

-# **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 - +- [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! + -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 -

+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. + +

-## VISITORS +If you want to support Dantotsu's maintainer consider donating + + + +## 👀 VISITORS :rebeloniondantotsu -## LICENSE 📜 +## 📜 LICENSE Dantotsu is licensed under the [GNU General Public License v3.0](LICENSE.md) diff --git a/assets/badge_obtainium.png b/assets/badge_obtainium.png new file mode 100644 index 0000000000..a4cf4f9cac Binary files /dev/null and b/assets/badge_obtainium.png differ diff --git a/assets/banner.png b/assets/banner.png new file mode 100644 index 0000000000..73ead69455 Binary files /dev/null and b/assets/banner.png differ diff --git a/assets/dantotsu-screenshot.png b/assets/dantotsu-screenshot.png new file mode 100644 index 0000000000..2e34e9446f Binary files /dev/null and b/assets/dantotsu-screenshot.png differ diff --git a/assets/get-it-on-github.png b/assets/get-it-on-github.png new file mode 100644 index 0000000000..f869aa5178 Binary files /dev/null and b/assets/get-it-on-github.png differ diff --git a/docs/README.es.md b/docs/README.es.md new file mode 100644 index 0000000000..74ee2d5b92 --- /dev/null +++ b/docs/README.es.md @@ -0,0 +1,91 @@ +![banner](../assets/banner.png) + +

+Un Cliente de AniList FOSS +

+ +

+Dantotsu (断トツ; Dan-totsu) "lo mejor de lo mejor". Pruebalo y juzga tu mismo! +

+ +

+ + + CodeFactor + +

+ +![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 + + + +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. + +

+ + + +

+ +Si deseas apoyar al mantenedor de Dantotsu, considera donarle + + + +## 👀 VISITANTES + +:rebeloniondantotsu + +## 📜 LICENCIA + +Dantotsu esta licenciado bajo [GNU General Public License v3.0](LICENSE.md)