update documentation

Author: SirCotare

deploy/action.yml

@@ -3,11 +3,14 @@ description: 'Deploy an application to a Kubernetes cluster.'
 
 inputs:
   deployment-file:
-    description: '"test" or "prod"'
+    description: 'Deployment file for kubectl to apply'
+    required: true
   namespace-name:
     description: 'Kubernetes namespace name'
+    required: true
   deployment-name:
     description: 'Kubernetes deployment name'
+    required: true
 
 runs:
   using: "composite"

do-setup-kubectl/action.yml

@@ -4,8 +4,10 @@ description: 'Setup DigitalOcean CLI and configure kubectl.'
 inputs:
   digital-ocean-token:
     description: 'Digital Ocean access token'
+    required: true
   cluster-name:
     description: 'Kubernetes cluster name'
+    required: true
 
 runs:
   using: "composite"

readme.md

@@ -1,12 +1,14 @@
 # GitHub Actions Kubernetes
 
-A collection of GitHub actions for Kubernetes.
+A collection of Kubernetes related GitHub actions.
 
-## Setup DigitalOcean
+## Actions
+
+### Setup DigitalOcean
 
 Setup Digital-Ocean CLI and configure Kubernetes.
 
-### Example
+#### Example
 
 ```yaml
   - uses: aboutbits/github-actions-kubernetes/do-setup-kubectl@v1
@@ -15,11 +17,21 @@ Setup Digital-Ocean CLI and configure Kubernetes.
       cluster-name: ${{ env.CLUSTER_NAME }}
 ```
 
-## Deploy to Kubernetes
+#### Inputs
+
+Following inputs can be used as `step.with` keys
+
+| Name                     | Required/Default   | Description                     |
+|--------------------------|--------------------|---------------------------------|
+| `digital-ocean-token`    | required           | Digital Ocean access token      |
+| `cluster-name`           | required           | Kubernetes cluster name         |
+
+
+### Deploy to Kubernetes
 
 Deploy application to a Kubernetes Cluster. Requires Kubernetes to be configured first.
 
-### Example
+#### Example
 
 ```yaml
   - uses: aboutbits/github-actions-kubernetes/deploy@v1
@@ -29,6 +41,17 @@ Deploy application to a Kubernetes Cluster. Requires Kubernetes to be configured
       deployment-name: ${{ env.DEPLOYMENT_NAME }}
 ```
 
+#### Inputs
+
+Following inputs can be used as `step.with` keys
+
+| Name                 | Required/Default   | Description                               |
+|----------------------|--------------------|-------------------------------------------|
+| `deployment-file`    | required           | Deployment file for kubectl to apply      |
+| `namespace-name`     | required           | Kubernetes namespace name                 |
+| `deployment-name`    | required           | Kubernetes deployment name                |
+
+
 ## Versioning
 
 In order to have a versioning in place and working, create lightweight tags that point to the appropriate minor release versions.