Add readme and rewrite some description

Author: jrandiny

action.yml

@@ -1,5 +1,5 @@
-name: "Github page APT repo"
-description: "Setup and manage APT repo"
+name: "Github pages APT repo"
+description: "Setup and manage APT repo on Github pages"
 inputs:
   github_token:
     description: "Github token with commit and push scope"
@@ -8,7 +8,7 @@ inputs:
     description: "Newline-delimited list of supported architecture"
     required: true
   version:
-    description: "Newline-delimited list of supported version"
+    description: "Newline-delimited list of supported (linux) version"
     required: true
   file:
     description: "Newline-delimited list of .deb files"
@@ -26,11 +26,11 @@ inputs:
     description: "Passphrase of GPG private key"
     required: false
   page_branch:
-    description: "Branch of Github page"
+    description: "Branch of Github pages"
     required: false
     default: "gh-pages"
   repo_folder:
-    description: "Location of APT repo folder relative to root of Github page"
+    description: "Location of APT repo folder relative to root of Github pages"
     required: false
     default: "repo"
   debug:

readme.md

@@ -0,0 +1,64 @@
+# Github pages APT repo
+
+This action will setup and manage a simple APT repo on your github pages
+
+## Inputs
+
+### `github_token`
+
+**Required** Personal access token with commit and push scope granted.
+
+### `arch`
+
+**Required** Newline-delimited list of supported architecture
+
+### `version`
+
+**Required** Newline-delimited list of supported (linux) version
+
+### `file`
+
+**Required** Newline-delimited list of .deb files to be included
+
+### `file_target_version`
+
+**Required** Newline-delimited list of (linux) version target of supplied .deb file
+
+### `private_key`
+
+**Required** GPG private key for signing APT repo
+
+### `public_key`
+
+GPG public key for APT repo
+
+### `key_passphrase`
+
+Passphrase of GPG private key
+
+### `page_branch`
+
+Branch of Github pages. Defaults to `gh-pages`
+
+### `repo_folder`
+
+Location of APT repo folder relative to root of Github pages. Defaults to `repo`
+
+## Example usage
+
+```yaml
+uses: jrandiny/apt-repo-action@v1
+with:
+  github_token: ${{ secrets.PAT }}
+  arch: |
+    amd64
+    i386
+  version: |
+    bionic
+    trusty
+  file: my_program_bionic.deb
+  file_target_version: bionic
+  public_key: ${{ secrets.PUBLIC }}
+  private_key: ${{ secrets.PRIVATE }}
+  key_passphrase: ${{ secrets.SECRET }}
+```