Feature/bug 26 javadoc

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: maven
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"

.github/workflows/maven.yml

@@ -0,0 +1,27 @@
+name: Java CI with Maven
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Java ${{ matrix.java_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        java_version: ['8', '11', '17']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK ${{ matrix.java_version }}
+        uses: actions/setup-java@v3
+        with:
+          java-version: ${{ matrix.java_version }}
+          distribution: 'temurin'
+          cache: maven
+      - name: Build with Maven
+        run: mvn -B package --file pom.xml

.gitignore

@@ -1,11 +1,14 @@
 .classpath
 .settings
 .project
-.idea
 workspace.xml
 bin
 target
-src/main/java/com/joestelmach/natty/generated/*
+src/main/java/org/natty/generated/*
 src/main/java/*.tokens
-src/main/antlr3/com/joestelmach/natty/generated/DebugDateParser.g
-src/main/antlr3/com/joestelmach/natty/generated/DebugDateWalker.g
+src/main/antlr3/org/natty/generated/DebugDateParser.g
+src/main/antlr3/org/natty/generated/DebugDateWalker.g
+
+# IntelliJ Idea
+*.iml
+.idea

README.md

@@ -0,0 +1,52 @@
+## What
+
+Natty is a natural language date parser written in Java.  Given a date
+expression, natty will apply standard language recognition and translation
+techniques to produce a list of corresponding dates with optional parse and
+syntax information.
+
+## History
+
+Originally written by Joel Stelmach at https://github.com/joestelmach/natty and developed between 2010 and 2017. Abandoned since then.
+
+## Usage
+Maven:
+```
+<dependency>
+  <groupId>io.github.natty-parser</groupId>
+  <artifactId>natty</artifactId>
+  <version>1.0.1</version>
+</dependency>
+```
+
+or [consult maven.org](https://search.maven.org/artifact/io.github.natty-parser/natty) for other build systems.
+
+## Idea behind the fork
+
+Started with [a thread in the original project](https://github.com/joestelmach/natty/issues/274). The aim is to try providing maintenance for the library.
+
+Plan / Priorities (as of November 2022):
+
+1. ~~Release version `1.0.0` with (possibly) the same code as the fork root, but under new name, consider renaming packages and artifacts to use `natty-parser` as the moniker, etc.~~
+DONE
+2. ~~Fix the tests (some are failing?).~~ DONE
+3. Set up basic technicalities of the fork - Maven release process, CI (Continuous Integration), etc. 
+4. Start accepting contributions (PRs), encourage the community to solve [issues reported in the original repo](https://github.com/joestelmach/natty/issues)
+5. Consider switching to Gradle (as this is a build tool which is modern and I am familiar with)
+6. Decide on the overall vision of the project - at this point it's hard to tell, but I think a conscious decision on what is gonna be supported would be
+great - i.e. focus on i18n, customization, stability, or what?
+
+## Known issues from the parent project
+
+See [issues](issues.md)
+
+## Commitment
+
+I hope for open collaboration and contributions from others. To me it's totally a side-project, not the core activity. Yet, I can commit to being (fairly) responsive and inclusive.
+
+## Contibutions
+
+Are more then welcome. Feel free to reach out (e.g. by creating an issue in this repo) to offer your support and ideas. I am happy to include more
+maintainers. Tag @mccartney if no response for 2-3 days (I might have missed that).
+
+I see this project potentially being welcoming to many, incl. quite junior and inexperienced developers, who would like to learn and contribute.