Skip to content

Commit 1a3c7e4

Browse files
authored
Update README.md
1 parent a9592f5 commit 1a3c7e4

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,26 @@ a simple and <b>async</b> java-library for mysql and mongodb <b>database-connect
1212
It is an easy-to-use library that (until now) can connect to mysql and mongodb databases.<br>
1313
In addition, interactions with databases are simplified.
1414

15-
[getting started](#-getting-started)
16-
[report a bug](#configuration)
17-
[feature request](#third-party-integrations)
15+
[getting started](#-installation)
16+
[report a bug](#%EF%B8%8F-contributing)
17+
[feature request](#%EF%B8%8F-contributing)
1818

1919
</div>
2020

2121
---
2222

2323
## Table of Contents
24-
- [🧪 Installation](#-getting-started)
24+
- [🧪 Installation](#-installation)
2525
- [📖 Code examples](#-code-examples)
26-
- [🗺️ Project structure](#%EF%B8%8F-project-structure)
26+
- [📍 MySQL](#mysql-database-connection)
27+
- [📍 MongoDB](#mongo-database-connection)
2728
- [⌛ Pending tasks](#-pending-tasks)
28-
- [📜 License](#-license)
29+
- [🗺️ Contributing](#%EF%B8%8F-contributing)
2930
- [☎️ Contact](#%EF%B8%8F-contact)
31+
- [📜 License](#-license)
32+
<!--
33+
- [🗺️ Project structure](#)
34+
-->
3035

3136
---
3237

@@ -157,13 +162,31 @@ The connection can finally be closed by calling this method:
157162
```java
158163
mongoDatabaseConnection.disconnect();
159164
```
165+
---
166+
167+
## ⌛ Pending tasks
168+
> 🤖 Please suggest features that we should still include in the api.
169+
> Read [Contributing](#%EF%B8%8F-contributing) for details.
170+
- [ ] test mongo-database-module
171+
- [ ] \(Optional) integrate other databases into the api
172+
173+
---
174+
175+
## 🗺️ Contributing
176+
Before submitting issues and pull requests please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
177+
Please follow these guidelines to make life easier for all of us.
160178

161179
---
162180

163181
## 📜 License
164182
database-api is distributed under the terms of the `MIT License`. A complete version of the license is available in the [LICENSE.md](LICENSE.md) in this repository. Any contribution made to this project will be licensed under the `MIT License`.<br>
165183
All files are Copyright © 2022 Florian H. and all contributors.
166184

185+
---
186+
187+
## ☎️ Contact
188+
You can contact me via Discord: Heliumdioxid#3963
189+
167190
<!--
168191
*** ---
169192
***
@@ -187,8 +210,5 @@ All files are Copyright © 2022 Florian H. and all contributors.
187210
***
188211
*** ---
189212
***
190-
*** ## ☎️ Contact
191-
*** You can contact me via Discord: Heliumdioxid#3963
192-
***
193213
*** 📢🪛🔧🔨⛏️🪓🔩🪨🪵⚙️⚗️🧪🧬🧫🔭💡📍📌📏⌛⏳☁️🧩♻️🎮📒📬💬📖🤖
194-
-->
214+
-->

0 commit comments

Comments
 (0)