Updated README to clarify project purpose and usage guidelines

This commit is contained in:
Konrad Neitzel 2025-04-03 21:08:46 +02:00
parent b0beabf8b4
commit 1de814b4fa

View File

@ -1,23 +1,16 @@
# NeitzelLib Maven Project
Small Library with classes that I found helpfully or interesting.
## A Java Utilities Library
The idea is not to diretly use anything from this library. It is only meant to provide some code which could be a quick start when required inside a project. So simply copy the classes that you need.
This repository is **not** a production-ready library, but rather a loose collection of small helpers, utilities, and ideas that might come in handy for Java developers.
## Components
The code in this project is intended as a **starting point** or **inspiration** for your own solutions. It is often easier to copy and adapt individual classes as needed instead of using the whole library as a dependency.
### core
Feel free to explore, copy, modify, and improve whatever you find useful.
This is the core library that does not have special dependencies like JavaFX.
> ⚠️ Use at your own discretion — no guarantees of stability, backwards compatibility, or completeness.
It contains:
- **inject** Some small, basic Injection Library (Just a quick start)
- **sql** Helper classes to work with SQL in Java
---
### fx
Library that extends JavaFX or helps with it.
It contains:
- **component** Just a quick start where I experiment with the idea to have JavaFX components which means that we have a View to display a specific Model.
- **injectfx** Injection inside JavaFX, main idea is to use constructor injection on FXML controller to include required Elements.
- **mvvm** The mvvmFX project seems to get no more updates / is no longer maintained. In this area I am simply playing around with some helper classes to make the use of the mvvm pattern easier through generation of ViewModels. **Currently not really useable**
## License
This is free and unencumbered software released into the public domain. Please see the [License](LICENSE.md) for details.