Skip to content

Commit 0b217e9

Browse files
Sandro642gitbook-bot
authored andcommitted
GITBOOK-1: No subject
1 parent d577b0e commit 0b217e9

2 files changed

Lines changed: 70 additions & 93 deletions

File tree

Lines changed: 67 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,23 @@
1-
<div align="center">
1+
# Welcome on ConnectLib Docs
22

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

5-
<br>
5+
\
66

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)
107

11-
</div>
8+
![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)
9+
10+
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.
1211

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.
1512
> For information, this library is not intended to be used for Minecraft, it is used professionally in a Java project.
1613
17-
---
14+
***
1815

1916
```java
2017
Stable Version: 0.3.5-STABLE
2118
```
2219

23-
---
20+
***
2421

2522
```java[build.gradle](build.gradle)
2623
Support Lib : Java 23
@@ -31,20 +28,23 @@ Hook -----------------------|
3128
3229
- Coming Soon.
3330
```
34-
---
35-
## LangManager
31+
32+
***
33+
34+
### LangManager
35+
3636
```
3737
EN : Released - Version 1.3 - Latest Version
3838
FR : Sorti - Version 1.2 - Latest Version
39-
```
39+
```
4040

41-
---
41+
***
4242

4343
Stay informed about the latest features and updates of ConnectLib.
4444

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

4949
Changelog:
5050

@@ -62,50 +62,54 @@ Changelog:
6262
- [0.3.5-STABLE]: Now you can print the StatusCode of the response with ( response.getStatusCode(); )
6363
```
6464

65-
---
65+
***
6666

67-
## 🌟 Why ConnectLib?
67+
### 🌟 Why ConnectLib?
6868

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

71-
- **Centralize** your API connections
72-
- **Automate** your recurring tasks
73-
- **Secure** your data exchanges
74-
- **Simplify** adding new connectors
71+
* **Centralize** your API connections
72+
* **Automate** your recurring tasks
73+
* **Secure** your data exchanges
74+
* **Simplify** adding new connectors
75+
76+
***
77+
78+
### 🛠️ Main Features
79+
80+
* 🔌 **Centralized connector management**
81+
* ⚡ **Automated job execution**
82+
* 🧩 **Extensible and modular**
83+
* 📊 **Detailed logs and monitoring**
84+
* 🔒 **Built-in security**
7585

76-
---
86+
***
7787

78-
## 🛠️ Main Features
88+
### 🚦 Quick Start
7989

80-
- 🔌 **Centralized connector management**
81-
- ⚡ **Automated job execution**
82-
- 🧩 **Extensible and modular**
83-
- 📊 **Detailed logs and monitoring**
84-
- 🔒 **Built-in security**
90+
1. **Clone the project**
8591

86-
---
92+
```bash
93+
git clone https://github.com/your-username/ConnectLib.git
94+
cd ConnectLib
95+
```
96+
2. **Compile**
8797

88-
## 🚦 Quick Start
98+
```bash
99+
./gradlew build
100+
```
101+
3. **Run an example**
89102

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

104-
---
107+
***
105108

106-
## 🧑‍💻 Usage Example
109+
### 🧑‍💻 Usage Example
107110

108111
Library Import
112+
109113
```java
110114
repositories {
111115

@@ -121,70 +125,40 @@ dependencies {
121125

122126
}
123127

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

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

158-
---
132+
***
159133

160-
## 📚 Project Structure
134+
### 📚 Project Structure
161135

162-
- `src/main/java/fr/sandro642/github/` : main source code
163-
- `src/test/java/fr/sandro642/github/test/` : unit tests
164-
- `build.gradle` : Gradle configuration
136+
* `src/main/java/fr/sandro642/github/` : main source code
137+
* `src/test/java/fr/sandro642/github/test/` : unit tests
138+
* `build.gradle` : Gradle configuration
165139

166-
---
140+
***
167141

168-
## 🤝 Contributing
142+
### 🤝 Contributing
169143

170144
1. Fork the repo
171145
2. Create a branch (`feature/my-feature`)
172146
3. Push your changes and open a PR
173147

174-
---
148+
***
175149

176-
## 🧠 Evolution Ideas
150+
### 🧠 Evolution Ideas
177151

178-
- Adding connectors for new services
179-
- Web management interface
180-
- Plugin system
152+
* Adding connectors for new services
153+
* Web management interface
154+
* Plugin system
181155

182-
---
156+
***
183157

184-
## 📞 Contact
158+
### 📞 Contact
185159

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

188-
---
162+
***
189163

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

SUMMARY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Table of contents
2+
3+
* [Welcome on ConnectLib Docs](README.md)

0 commit comments

Comments
 (0)