Merge pull request #3 from aboutbits/feature/initV1

update readme

Author: SirCotare

readme.md

@@ -4,18 +4,29 @@ A collection of GitHub actions for Java projects.
 
 ## Actions
 
-### Setup Node and Install Dependencies
+### Setup Java and Install Dependencies
 
 This action will set up the Java SDK and install all dependencies.
 
-Example:
+#### Example:
 
 ```yaml
   - uses: actions/checkout@v3
 
   - uses: aboutbits/github-actions-java/setup-and-install@v1
 ```
 
+#### Inputs
+
+The following inputs can be used as `step.with` keys:
+
+| Name                   | Required/Default | Description               |
+|------------------------|------------------|---------------------------|
+| `working-directory`    | `.`              | The working directory     |
+| `java-version`         | `17`             | Java Version              |
+| `distribution`         | `corretto`       | Java Distribution         |
+
+
 ## Versioning
 
 In order to have a versioning in place and working, create lightweight tags that point to the appropriate minor release versions.

setup-and-install/action.yml

@@ -1,10 +1,9 @@
 name: 'Setup Java and install dependencies'
-description: 'Setup Java SDK, fetch and cache packages dependencies.'
+description: 'Setup Java SDK, fetch and cache packages dependencies'
 
 inputs:
   working-directory:
     description: 'The working directory'
-    required: false
     default: '.'
   java-version:
     default: '17'