From 2308dd49f540313b13a27e395791864615af8a65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9luchu?= Date: Thu, 21 Nov 2024 09:52:23 +0100 Subject: [PATCH] Initial README --- .gitignore | 2 + README.md | 122 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 124 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9bea433 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ + +.DS_Store diff --git a/README.md b/README.md new file mode 100644 index 0000000..cf1ad37 --- /dev/null +++ b/README.md @@ -0,0 +1,122 @@ + # **Aruppi API** (v5.0.0) (Preview release) + +> This API has everything about Japan, from anime, music, radio, images, videos ... to japanese culture +> +> These are the services used for the Aruppi App (only available in Spanish language) + +![type code](https://img.shields.io/badge/aruppi-API-brightgreen.svg) +![maintenance](https://img.shields.io/badge/maintained-Yes-brightgreen.svg) +![gitrepo](https://img.shields.io/github/stars/aruppi/aruppi-api?style=social) + +# + + + +  +  +  + +  +  +  + +Aruppi API has been developed to bring together all the information about Japanese culture, from anime and manga to the most secret places in Japan, its gastronomy and even its festivities. + +We are in continuous development to implement more features and improvements in the functioning of it, to later implement it in the mobile application. + +## **:wrench: Developer usage** + +### **Set up project** + +Comming Soon + +--- + +### **Installation** + +Comming Soon + +--- + +### Start the project + +Comming Soon + +### Build the Project + +Comming Soon + +### Test the project + +Comming Soon + +## 📖 API Documentation + +**Documentation coming soon** at the following link: [**Aruppi Wiki**](https://github.com/aruppi/aruppi-api/wiki) +Where we will show more information about the calls and queries together with the response obtained or the different types of variables in some of the queries. + +## Countdown to deprecation of v3 API + +Aruppi API version 4.x.x has been deprecated, that's why all of you who are using it should migrate as soon as possible to version 5.x.x which we have already released. + +Otherwise, if you want to use older versions you can host them yourself on your servers, and download the code in the corresponding branches of [**v2.x.x**](https://github.com/aruppi/aruppi-api/tree/v2) and [**v3.x.x**](https://github.com/aruppi/aruppi-api/tree/v3). In case you want to use an even lower version of the API we recommend you to have a look at this other version [**v1.x.x**](https://github.com/aruppi/aruppi-api-v1) + +Currently the Aruppi app on Android is already using the v5.x.x API services from version v3.0.0, which you can download from our website: [**Download Aruppi App**](https://aruppi.jeluchu.com/download) + +### **📚 Projects that use the API** + + + + + + +
+ + Jeluchu
+ + Aruppi + +
+ Anime y Manga + + 		+ + Jeluchu
+ + Akiyama + +
+ Web and App + +
+ +## Contributors ✨ + +Here are the **main contributors to the API**, along with Aruppi's creator + + + + + +

Jéluchu
📸 🌍 📢🔍
+ +There are also **people who have made contributions** and therefore it is also important to highlight them. + + + + + + + + +

Fmaldonado6

HernanSsj

Guillermo

Darkangeel-hd
+ +# + +### **:busts_in_silhouette: Credits** + +- [Darkangeel](https://github.com/Darkangeel-hd) (System administration authority (SYSADM)) +- [Jéluchu](https://github.com/Jeluchu) (Multiplatform Developer, designer, and others) +- [Capitanwesler](https://github.com/capitanwesler) (Backend developer, web developer and others) + +Copyright © 2022 [Jéluchu](https://about.jeluchu.com/).