Skip to content

Commit 032fd7f

Browse files
authored
Update README.md
1 parent 0f64684 commit 032fd7f

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,43 @@
11
[![Maven Central](https://img.shields.io/maven-central/v/io.github.mbenincasa/java-excel-utils.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.mbenincasa%22%20AND%20a:%22java-excel-utils%22)
22
[![GitHub release](https://img.shields.io/github/release/MBenincasa/java-excel-utils)](https://github.com/MBenincasa/java-excel-utils/releases/)
33
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
4+
45
# Java Excel Utils
56

7+
## Introduction
68
Java Excel Utils is still an embryonic project. This open source library will collect different tools to speed up the work with Excel files.
79

8-
There is currently no documentation, but it will be added as soon as possible.
10+
## Documentation
11+
The javadocs of all public methods are available. Some examples are also available in the `samples` package.
12+
13+
## Minimum Requirements ##
14+
Java 17 or above.
15+
16+
## Maven
17+
```xml
18+
<dependency>
19+
<groupId>io.github.mbenincasa</groupId>
20+
<artifactId>java-excel-utils</artifactId>
21+
<version>x.y.z</version>
22+
</dependency>
23+
```
24+
25+
## Roadmap
26+
There is still no well-defined roadmap, but there is the idea of bringing various features
27+
28+
## Contributing
29+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
30+
31+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
32+
Don't forget to give the project a star! Thanks again!
33+
1. Fork the Project
34+
2. Create your Feature Branch
35+
3. Commit your Changes
36+
4. Push to the Branch
37+
5. Open a Pull Request
38+
39+
## License
40+
Distributed under the GNU General Public License v3.0. See `LICENSE.md` for more information.
941

10-
If you're interested in the project, don't be afraid to contribute, even if you're simply asking for a new feature to be implemented.
42+
## Contact
43+
Mirko Benincasa - mirkobenincasa44@gmail.com

0 commit comments

Comments
 (0)