Skip to content

Commit 523cb73

Browse files
authored
Update README.md
1 parent 64bd913 commit 523cb73

1 file changed

Lines changed: 97 additions & 72 deletions

File tree

README.md

Lines changed: 97 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
1-
<center>
2-
<img href="banner.png">
3-
</center>
1+
<div align="center">
42

3+
![ConnectLib Banner](./banner.png)
54

5+
<br>
66

7-
![Version](https://img.shields.io/github/v/tag/Sandro642/ConnectLib?label=Version\&style=for-the-badge\&color=blue\&logo=github) ![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge\&logo=openjdk\&logoColor=white) ![Project Reactor](https://img.shields.io/badge/Project%20Reactor-6DB33F?style=for-the-badge\&logo=spring\&logoColor=white)
7+
![Version](https://img.shields.io/github/v/tag/Sandro642/ConnectLib?label=Version&style=for-the-badge&color=blue&logo=github)
8+
![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)
9+
![Project Reactor](https://img.shields.io/badge/Project%20Reactor-6DB33F?style=for-the-badge&logo=spring&logoColor=white)
810

9-
Welcome to **ConnectLib**: the universal gateway to connect, automate and orchestrate your data flows! And if you thought APIs were complicated, think again! With ConnectLib, it's like playing with Lego: simple, intuitive and powerful.
11+
</div>
1012

13+
Welcome to **ConnectLib**: the universal gateway to connect, automate and orchestrate your data flows!
14+
And if you thought APIs were complicated, think again! With ConnectLib, it's like playing with Lego: simple, intuitive and powerful.
1115
> For information, this library is not intended to be used for Minecraft, it is used professionally in a Java project.
1216
13-
***
17+
---
1418

1519
```java
16-
Stable Version: 0.3.5-STABLE
20+
Stable Version: 0.3.2-STABLE
1721
```
1822

19-
***
23+
---
2024

2125
```java[build.gradle](build.gradle)
2226
Support Lib : Java 23
@@ -27,23 +31,20 @@ Hook -----------------------|
2731
2832
- Coming Soon.
2933
```
30-
31-
***
32-
33-
### LangManager
34-
35-
```
36-
EN : Released - Version 1.3 - Latest Version
37-
FR : Sorti - Version 1.2 - Latest Version
34+
---
35+
## LangManager
3836
```
37+
EN : Released - Version 1.2
38+
FR : Sorti - Version 1.1
39+
```
3940

40-
***
41+
---
4142

4243
Stay informed about the latest features and updates of ConnectLib.
4344

44-
* Advanced debugging system. Available soon. [readme.md](./)
45-
46-
***
45+
- Advanced debugging system. Available soon.
46+
[readme.md](readme.md)
47+
---
4748

4849
Changelog:
4950

@@ -57,58 +58,52 @@ Changelog:
5758
- [0.2.6.4-STABLE]: Added asynchronous job execution, allowing you to run tasks in the background without blocking your main application thread.
5859
- [0.2.7.2-STABLE]: Remove implementation Project Reactor
5960
- [0.2.9-STABLE]: Added support query variables in routes, allowing you to pass parameters directly in the URL.
60-
- [0.3.3-STABLE]: Minecraft Version 1.16 - Latest Version support + LangType 2.0 - Remove AnnotHandler, you can use logger.showLogs(); to display logs.
61-
- [0.3.5-STABLE]: Now you can print the StatusCode of the response with ( response.getStatusCode(); )
6261
```
6362

64-
***
63+
---
6564

66-
### 🌟 Why ConnectLib?
65+
## 🌟 Why ConnectLib?
6766

6867
Imagine an API that doesn't just connect services, but becomes the conductor of your integrations. ConnectLib is designed to:
6968

70-
* **Centralize** your API connections
71-
* **Automate** your recurring tasks
72-
* **Secure** your data exchanges
73-
* **Simplify** adding new connectors
69+
- **Centralize** your API connections
70+
- **Automate** your recurring tasks
71+
- **Secure** your data exchanges
72+
- **Simplify** adding new connectors
7473

75-
***
74+
---
7675

77-
### 🛠️ Main Features
76+
## 🛠️ Main Features
7877

79-
* 🔌 **Centralized connector management**
80-
* ⚡ **Automated job execution**
81-
* 🧩 **Extensible and modular**
82-
* 📊 **Detailed logs and monitoring**
83-
* 🔒 **Built-in security**
78+
- 🔌 **Centralized connector management**
79+
- ⚡ **Automated job execution**
80+
- 🧩 **Extensible and modular**
81+
- 📊 **Detailed logs and monitoring**
82+
- 🔒 **Built-in security**
8483

85-
***
84+
---
8685

87-
### 🚦 Quick Start
86+
## 🚦 Quick Start
8887

89-
1. **Clone the project**
88+
1. **Clone the project**
89+
```bash
90+
git clone https://github.com/your-username/ConnectLib.git
91+
cd ConnectLib
92+
```
93+
2. **Compile**
94+
```bash
95+
./gradlew build
96+
```
97+
3. **Run an example**
98+
```bash
99+
java -jar YourJarFile.jar
100+
```
90101

91-
```bash
92-
git clone https://github.com/your-username/ConnectLib.git
93-
cd ConnectLib
94-
```
95-
2. **Compile**
102+
---
96103

97-
```bash
98-
./gradlew build
99-
```
100-
3. **Run an example**
101-
102-
```bash
103-
java -jar YourJarFile.jar
104-
```
105-
106-
***
107-
108-
### 🧑‍💻 Usage Example
104+
## 🧑‍💻 Usage Example
109105

110106
Library Import
111-
112107
```java
113108
repositories {
114109

@@ -120,44 +115,74 @@ repositories {
120115

121116
dependencies {
122117

123-
implementation("fr.sandro642.github:ConnectLib:0.3.5-STABLE")
118+
implementation("fr.sandro642.github:ConnectLib:0.3.2-STABLE")
124119

125120
}
126121

122+
```
123+
Library Initialization
124+
```java
125+
public class Example {
126+
127+
// Initialization with an enumeration
128+
public enum RouteList implements ConvertEnum.RouteImport {
129+
VERSION("/api/mcas/info/version"),
130+
INFO("/api/mcas/info/info");
131+
132+
String route;
133+
134+
TestRoutes(String route) {
135+
this.route = route;
136+
}
137+
138+
@Override
139+
public String route() {
140+
return route;
141+
}
142+
}
143+
144+
ConnectLib.initialize(ResourceType.MAIN_RESOURCES, RouteList.class);
145+
146+
147+
///////////////////////////////////////////////////////////////////////////
148+
ConnectLib.initialize(ResourceType.MAIN_RESOURCES);
149+
150+
//Add your routes in the infos.yml file
151+
}
127152
```
128153

129154
More examples HERE: [ExampleUsages.java](src/main/java/fr/sandro642/github/example/ExampleUsages.java)
130155

131-
***
156+
---
132157

133-
### 📚 Project Structure
158+
## 📚 Project Structure
134159

135-
* `src/main/java/fr/sandro642/github/` : main source code
136-
* `src/test/java/fr/sandro642/github/test/` : unit tests
137-
* `build.gradle` : Gradle configuration
160+
- `src/main/java/fr/sandro642/github/` : main source code
161+
- `src/test/java/fr/sandro642/github/test/` : unit tests
162+
- `build.gradle` : Gradle configuration
138163

139-
***
164+
---
140165

141-
### 🤝 Contributing
166+
## 🤝 Contributing
142167

143168
1. Fork the repo
144169
2. Create a branch (`feature/my-feature`)
145170
3. Push your changes and open a PR
146171

147-
***
172+
---
148173

149-
### 🧠 Evolution Ideas
174+
## 🧠 Evolution Ideas
150175

151-
* Adding connectors for new services
152-
* Web management interface
153-
* Plugin system
176+
- Adding connectors for new services
177+
- Web management interface
178+
- Plugin system
154179

155-
***
180+
---
156181

157-
### 📞 Contact
182+
## 📞 Contact
158183

159184
For any questions or suggestions: [sandro33810@gmail.com](mailto:sandro33810@gmail.com)
160185

161-
***
186+
---
162187

163188
> "ConnectLib is the freedom to connect the impossible."

0 commit comments

Comments
 (0)