feat: set initial implementation

Author: Totremont

README.md

@@ -4,13 +4,26 @@
 [![Maven Central](https://img.shields.io/maven-central/v/com.flowingcode.vaadin.addons/template-addon)](https://mvnrepository.com/artifact/com.flowingcode.vaadin.addons/template-addon)
 [![Javadoc](https://img.shields.io/badge/javadoc-00b4f0)](https://javadoc.flowingcode.com/artifact/com.flowingcode.vaadin.addons/template-addon)
 
-# Template Add-on
+# DateTimeRangePicker Add-on for Vaadin
 
-This is a template project for building new Vaadin 24 add-ons
+DateTimeRangePicker is a component add-on for Vaadin Framework version 14+ that assists
+on the creation of 
+[time intervals](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) 
+(a time period delimited by two instants),
+that conform to certain date and time constraints. 
+It includes a DateTimeRange class with an API to operate TimeInterval class instances.
 
-## Features
+As an example, you could set the component to handle time intervals that occur every weekend from 8:30 to 12:30 AM between the
+1st and 15th of May 2025. Then, you would get a DateTimeRange object and use it to consult if a certain instant is included 
+or when will the next time interval start.
+
+**Note:** current implementation **does not** support custom time zones. It uses the system's default.
 
-* List the features of your add-on in here
+## Features
+- Customizable selection of date, time and days.
+- API to create and query time intervals. It supports two work modes:
+  - **Lazy** mode (default): does not store time intervals and instead creates them when requested.
+  - **Eager** mode: valid time intervals must be created and stored before any request is made.
 
 ## Online demo
 
@@ -27,7 +40,7 @@ Add the following dependencies in your pom.xml file:
 ```xml
 <dependency>
    <groupId>com.flowingcode.vaadin.addons</groupId>
-   <artifactId>template-addon</artifactId>
+   <artifactId>date-time-range-picker-addon</artifactId>
    <version>X.Y.Z</version>
 </dependency>
 ```
@@ -69,13 +82,52 @@ Then, follow these steps for creating a contribution:
 
 This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.
 
-TEMPLATE_ADDON is written by Flowing Code S.A.
+DateTimeRangePicker is written by Flowing Code S.A.
 
 # Developer Guide
 
 ## Getting started
 
-Add your code samples in this section
+A simple instantiation.
+```
+    DateTimeRangePicker addon = new DateTimeRangePicker();
+    addon.setMinDate(LocalDate.now());
+    addon.setMaxDate(LocalDate.now().plusDays(15));
+    addon.setWeekDays(DayOfWeek.MONDAY, DayOfWeek.FRIDAY);
+```
+Component will have monday and friday set by default and user will not 
+be allowed to select a start date earlier than today and an end date later than today plus fifteen days.
+
+## Binding
+
+Here **Pojo** has a **DateTimeRange** variable with getter and setter methods.
+
+```
+    DateTimeRangePicker addon = new DateTimeRangePicker();
+    Binder<Pojo> binder = new Binder<>(Pojo.class);
+    binder.forField(addon).bind(Pojo::getDateTimeRange, Pojo::setDateTimeRange);
+    binder.setBean(pojo);
+```
+After a successful validation you can use the return value to make queries.
+
+```
+    TimeInterval interval = pojo.getDateTimeRange().getNextInterval();
+    boolean includes = interval != null && interval.includes(LocalDateTime.now());
+```
+
+## DateTimeRange modes
+As described above, by default **TimeInterval** 
+instances are not stored but created and returned when needed. This is called **Lazy** mode.
+
+When the dataset is small, switching to **Eager** mode may yield better results, as the objects are created all at once.
+If you do, remember to call refresh() whenever the state of the DateTimeRange object changes.
+
+
+```
+    dateTimeRange.setFetchMode(FetchMode.EAGER);
+    dateTimeRange.refresh();
+```
+
 
 ## Special configuration when using Spring
 

pom.xml

@@ -5,14 +5,14 @@
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.flowingcode.vaadin.addons</groupId>
-    <artifactId>template-addon</artifactId>
+    <artifactId>date-time-range-picker-addon</artifactId>
     <version>1.0.0-SNAPSHOT</version>
-    <name>Template Add-on</name>
-    <description>Template Add-on for Vaadin Flow</description>
+    <name>DateTimeRangePicker</name>
+    <description>DateTimeRangePicker Vaadin Add-on</description>
     <url>https://www.flowingcode.com/en/open-source/</url>
 
     <properties>
-        <vaadin.version>24.4.6</vaadin.version>
+        <vaadin.version>24.4.7</vaadin.version>
         <selenium.version>4.10.0</selenium.version>
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
@@ -156,6 +156,13 @@
             <version>5.9.1</version>
             <scope>test</scope>
         </dependency>
+
+        <dependency>
+            <groupId>com.flowingcode.vaadin.addons</groupId>
+            <artifactId>day-of-week-selector-addon</artifactId>
+            <version>1.0.1</version>
+        </dependency>
+
     </dependencies>
 
     <build>