Skip to content

Commit 02bdda1

Browse files
authored
Update readme.md
1 parent 7870365 commit 02bdda1

1 file changed

Lines changed: 56 additions & 57 deletions

File tree

readme.md

Lines changed: 56 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# 🚀 ConnectorAPI
1+
# 🚀 ConnectLib
22

3-
Bienvenue dans **ConnectorAPI** : la passerelle universelle pour connecter, automatiser et orchestrer vos flux de données !
4-
Et si vous pensiez que les API étaient compliquées, détrompez-vous ! Avec ConnectorAPI, c’est comme jouer avec des Lego : simple, intuitif et puissant.
5-
> Pour information, cette librairie n'est pas destinée à être utilisée pour Minecraft, elle est utilisée afin professionnel dans un projet Java.
3+
Welcome to **ConnectLib**: the universal gateway to connect, automate and orchestrate your data flows!
4+
And if you thought APIs were complicated, think again! With ConnectLib, it's like playing with Lego: simple, intuitive and powerful.
5+
> For information, this library is not intended to be used for Minecraft, it is used professionally in a Java project.
66
77
---
88

99
```java
10-
Stable Version : 0.2.2-STABLE
10+
Stable Version: 0.2.2-STABLE
1111
```
1212

1313
---
@@ -18,91 +18,91 @@ Support Lib 23 | Future 24
1818
Hook -----------------------|
1919
- Support Minecraft 1.8
2020

21-
- Comming Soon.
21+
- Coming Soon.
2222
```
2323
---
2424

25-
Être tenu au courant des dernières features et mises à jour de ConnectorAPI.
25+
Stay informed about the latest features and updates of ConnectLib.
2626

27-
- Système de débugging avancé. Disponible prochainement.
27+
- Advanced debugging system. Available soon.
2828

2929
---
3030

31-
Changelog :
31+
Changelog:
3232

3333
```java
34-
- [0.1.3.9-SNAPSHOT] : Ajout de la sérialisation des données pour une compatibilisation parfaite des données avec les HOOK.
35-
- [0.1.3.17-SNAPSHOT] : Suppresion de la sérialisation des données... Toujours disponible depuis la branche /feature/serializer. Utile si les processus ne sont pas initialisé dans le même environnement.
36-
- [0.1.9.2-STABLE] : Patch de sécurité en utilisant la méthode getRoutes en utilisant une classe enumération pour la routeName : StackOverflowError... + Création des maps selon le type de variable souhaité.
37-
- [0.2.0-STABLE] : Woaw arrivé de la 0.2.0 en si peu de temps ? Il y en avait des choses à faire sur ce projet ;)
38-
- [0.2.2-STABLE] : Ajout de la création de logs.
34+
- [0.1.3.9-SNAPSHOT]: Added data serialization for perfect data compatibility with HOOK.
35+
- [0.1.3.17-SNAPSHOT]: Removal of data serialization... Still available from the /feature/serializer branch. Useful if processes are not initialized in the same environment.
36+
- [0.1.9.2-STABLE]: Security patch using the getRoutes method using an enumeration class for routeName: StackOverflowError... + Creation of maps according to the desired variable type.
37+
- [0.2.0-STABLE]: Wow, arrival of 0.2.0 in such a short time? There were things to do on this project ;)
38+
- [0.2.2-STABLE]: Added log creation.
3939
```
4040

4141
---
4242

43-
## 🌟 Pourquoi ConnectorAPI ?
43+
## 🌟 Why ConnectLib?
4444

45-
Imaginez une API qui ne se contente pas de relier des services, mais qui devient le chef d’orchestre de vos intégrations. ConnectorAPI est conçu pour :
45+
Imagine an API that doesn't just connect services, but becomes the conductor of your integrations. ConnectLib is designed to:
4646

47-
- **Centraliser** vos connexions API
48-
- **Automatiser** vos tâches récurrentes
49-
- **Sécuriser** vos échanges de données
50-
- **Simplifier** l’ajout de nouveaux connecteurs
47+
- **Centralize** your API connections
48+
- **Automate** your recurring tasks
49+
- **Secure** your data exchanges
50+
- **Simplify** adding new connectors
5151

5252
---
5353

54-
## 🛠️ Fonctionnalités principales
54+
## 🛠️ Main Features
5555

56-
- 🔌 **Gestion centralisée des connecteurs**
57-
-**Exécution de jobs automatisés**
58-
- 🧩 **Extensible et modulaire**
59-
- 📊 **Logs détaillés et monitoring**
60-
- 🔒 **Sécurité intégrée**
56+
- 🔌 **Centralized connector management**
57+
- ⚡ **Automated job execution**
58+
- 🧩 **Extensible and modular**
59+
- 📊 **Detailed logs and monitoring**
60+
- 🔒 **Built-in security**
6161

6262
---
6363

64-
## 🚦 Démarrage rapide
64+
## 🚦 Quick Start
6565

66-
1. **Cloner le projet**
66+
1. **Clone the project**
6767
```bash
68-
git clone https://github.com/votre-utilisateur/ConnectorAPI.git
69-
cd ConnectorAPI
68+
git clone https://github.com/your-username/ConnectLib.git
69+
cd ConnectLib
7070
```
71-
2. **Compiler**
71+
2. **Compile**
7272
```bash
7373
./gradlew build
7474
```
75-
3. **Exécuter un exemple**
75+
3. **Run an example**
7676
```bash
7777
./gradlew run
7878
```
7979

8080
---
8181

82-
## 🧑‍💻 Exemple d’utilisation
82+
## 🧑‍💻 Usage Example
8383

84-
Importation de la librairie
84+
Library Import
8585
```java
8686
repositories {
8787

8888
maven {
89-
url = uri("https://sandro642.github.io/connectorapi/jar")
89+
url = uri("https://sandro642.github.io/connectlib/jar")
9090
}
9191

9292
}
9393

9494
dependencies {
9595

96-
implementation("fr.sandro642.github:ConnectorAPI:0.2.2-STABLE")
96+
implementation("fr.sandro642.github:ConnectLib:0.2.2-STABLE")
9797

9898
}
9999

100100
```
101-
Initialisation de la Librairie
101+
Library Initialization
102102
```java
103103
public class Example {
104104

105-
// Initialisation avec une enumération
105+
// Initialization with an enumeration
106106
public enum RouteList implements ConvertEnum.RouteImport {
107107
VERSION("/api/mcas/info/version"),
108108
INFO("/api/mcas/info/info");
@@ -119,49 +119,48 @@ public class Example {
119119
}
120120
}
121121

122-
ConnectorAPI.initialize(ResourceType.MAIN_RESOURCES, RouteList.class);
122+
ConnectLib.initialize(ResourceType.MAIN_RESOURCES, RouteList.class);
123123

124124

125125
///////////////////////////////////////////////////////////////////////////
126-
ConnectorAPI.initialize(ResourceType.MAIN_RESOURCES);
126+
ConnectLib.initialize(ResourceType.MAIN_RESOURCES);
127127

128-
//Rajouter vos routes dans le fichier infos.yml
128+
//Add your routes in the infos.yml file
129129
}
130130
```
131131

132-
Plus d'exemples dans ICI : [ExampleUsage.java](src/main/java/fr/sandro642/github/example/ExampleUsage.java) Non disponible pour le moment dû aux nouvelles features.
132+
More examples HERE: [ExampleUsage.java](src/main/java/fr/sandro642/github/example/ExampleUsage.java) Not available at the moment due to new features.
133133

134134
---
135135

136-
## 📚 Structure du projet
136+
## 📚 Project Structure
137137

138-
- `src/main/java/fr/sandro642/github/` : code source principal
139-
- `src/test/java/fr/sandro642/github/test/` : tests unitaires
140-
- `build.gradle` : configuration Gradle
138+
- `src/main/java/fr/sandro642/github/` : main source code
139+
- `src/test/java/fr/sandro642/github/test/` : unit tests
140+
- `build.gradle` : Gradle configuration
141141

142142
---
143143

144-
## 🤝 Contribuer
144+
## 🤝 Contributing
145145

146-
1. Forkez le repo
147-
2. Créez une branche (`feature/ma-fonctionnalite`)
148-
3. Poussez vos modifications et ouvrez une PR
146+
1. Fork the repo
147+
2. Create a branch (`feature/my-feature`)
148+
3. Push your changes and open a PR
149149

150150
---
151151

152-
## 🧠 Idées d’évolution
152+
## 🧠 Evolution Ideas
153153

154-
- Ajout de connecteurs pour de nouveaux services
155-
- Interface web de gestion
156-
- Système de plugins
154+
- Adding connectors for new services
155+
- Web management interface
156+
- Plugin system
157157

158158
---
159159

160160
## 📞 Contact
161161

162-
Pour toute question ou suggestion : [sandro33810@gmail.com](mailto:sandro33810@gmail.com)
162+
For any questions or suggestions: [sandro33810@gmail.com](mailto:sandro33810@gmail.com)
163163

164164
---
165165

166-
> "ConnectorAPI, c’est la liberté de connecter l’impossible."
167-
166+
> "ConnectLib is the freedom to connect the impossible."

0 commit comments

Comments
 (0)