docs(readme): Add README.md for Javadoc deployment action

- Introduced a README.md file to document the GitHub Action for deploying Javadoc to GitHub Pages.
- Included instructions on how to set up and use the action, with example workflows.
- Detailed the configurable inputs such as `GITHUB_TOKEN`, `BRANCH`, `JAVA_VERSION`, and others.
- Highlighted features like automatic Javadoc generation, customizable branch, JDK configuration, test skipping, and branch cleanup.
- Added a section on licensing under the Apache License 2.0.

Author: nicokempe

README.md

@@ -1,33 +1,35 @@
-# Deploy Javadoc to GitHub Pages
+# 📘 Deploy Javadoc to GitHub Pages
 
-This GitHub Action automates the deployment of Javadoc documentation to GitHub Pages. It builds your Java project, generates Javadoc, and publishes it to a GitHub Pages branch.
+This GitHub Action automates the deployment of Javadoc documentation to GitHub Pages. It builds your Java project, generates Javadoc, and publishes it to a specified branch, typically `gh-pages`.
 
-## Features
+## ✨ Features
 
-- **Automatic Javadoc Generation**: Builds the project and generates Javadoc documentation.
-- **Customizable Branch**: Publish Javadoc to a specified GitHub Pages branch.
-- **JDK Configuration**: Supports multiple JDK versions and distributions.
-- **Test Skipping**: Option to skip tests during the build process.
-- **Branch Cleanup**: Option to clean up old branches before publishing.
+- **Automatic Javadoc Generation**: Automatically builds the project and generates Javadoc documentation.
+- **Customizable Branch**: Allows publishing of Javadoc to a specified branch (default is `gh-pages`).
+- **Flexible JDK Configuration**: Supports multiple JDK versions and distributions, allowing for easy customization.
+- **Optional Test Skipping**: Configurable option to skip tests during the build process.
+- **Branch Cleanup**: Ability to clean up old branches before publishing, ensuring a fresh deployment environment.
 
-## Inputs
+## ⚙️ Inputs
+
+The following inputs can be configured for this action:
 
 ### `GITHUB_TOKEN`
 - **Description**: GitHub token used for repository access and authentication.
 - **Required**: Yes
 
 ### `BRANCH`
-- **Description**: The name of the branch where the Javadoc documentation will be published. Defaults to `'gh-pages'`.
+- **Description**: The branch where the Javadoc documentation will be published. Defaults to `'gh-pages'`.
 - **Required**: No
 - **Default**: `'gh-pages'`
 
 ### `BRANCH_CLEANUP`
-- **Description**: Whether to clean up old branches. Set to `'true'` to delete the old branch before publishing. Defaults to `'false'`.
+- **Description**: Whether to clean up old branches before publishing. Set to `'true'` to delete the old branch. Defaults to `'false'`.
 - **Required**: No
 - **Default**: `'false'`
 
 ### `JAVA_VERSION`
-- **Description**: The version of Java your project is using (e.g., 17).
+- **Description**: The version of Java your project is using (e.g., `17`).
 - **Required**: Yes
 - **Default**: `'17'`
 
@@ -37,22 +39,22 @@ This GitHub Action automates the deployment of Javadoc documentation to GitHub P
 - **Default**: `'adopt'`
 
 ### `SKIP_TESTS`
-- **Description**: Whether to skip tests during the build process. Set to `'true'` to skip tests, `'false'` otherwise.
+- **Description**: Whether to skip tests during the build process. Set to `'true'` to skip tests.
 - **Required**: No
 - **Default**: `'false'`
 
 ### `DOC_DIRECTORY`
-- **Description**: The directory where the Javadoc documentation is generated. Defaults to `'target/reports/apidocs'`.
+- **Description**: The directory where the Javadoc documentation is generated. Defaults to `'target/site/apidocs'`.
 - **Required**: No
-- **Default**: `'target/reports/apidocs'`
+- **Default**: `'target/site/apidocs'`
 
-## Usage
+## 🚀 Usage
 
 To use this GitHub Action, create a workflow YAML file in your repository's `.github/workflows` directory.
 
 ### Example Workflow
 
-Here’s an example workflow that builds the project, generates Javadoc, and publishes it to the `gh-pages` branch:
+Below is an example workflow that builds the project, generates Javadoc, and publishes it to the `gh-pages` branch:
 
 ```yaml
 name: Deploy Javadoc to GitHub Pages
@@ -77,14 +79,15 @@ jobs:
           JAVA_VERSION: '17'
           JAVA_DISTRIBUTION: 'adopt'
           SKIP_TESTS: 'false'
-          DOC_DIRECTORY: 'target/reports/apidocs'
+          DOC_DIRECTORY: 'target/site/apidocs'
           BRANCH: 'gh-pages'
           BRANCH_CLEANUP: 'false'
 ```
 
+
 ### Example with Branch Cleanup
 
-If you want to clean up old branches before publishing, set the CLEANUP_BRANCH input to 'true':
+To clean up old branches before publishing, set the `BRANCH_CLEANUP` input to 'true':
 
 ```yaml
 name: Deploy Javadoc to GitHub Pages
@@ -112,4 +115,7 @@ jobs:
           DOC_DIRECTORY: 'target/reports/apidocs'
           BRANCH: 'gh-pages'
           BRANCH_CLEANUP: 'true'
-```
+```
+
+## 📄 License
+This project is licensed under the Apache License 2.0 - see the [LICENSE file](https://github.com/DashioDevs/action-javadocs-deploy/blob/main/LICENSE) for details.