chore: action implementation

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 .eslintcache
+.nyc_output
 
 # JetBrains IDEs
 .idea

.nvmrc

@@ -1 +1 @@
-18
+16

README.md

@@ -2,4 +2,51 @@
 
 # github-action-licenses-export
 
-GitHub action that exports a file with the dependencies used in the application with their respective licenses.
+GitHub action that generates a file with the dependencies used in the application with their respective licenses. The file can be used to properly redistribute the licenses by displaying them in your application.
+
+## Inputs
+
+### `licenses-file`
+
+**Optional** Licenses output JSON file. Default `'licenses.json'`.
+
+### `omit-version`
+
+**Optional** Omit package versions from the report. Default `'true'`.
+
+### `production-only`
+
+**Optional** Only include production packages. Default `'true'`.
+
+### `direct-dependencies-only`
+
+**Optional** Only include direct dependencies. Default `'true'`.
+
+## Basic example
+
+```yaml
+name: Update licenses
+
+on:
+  push:
+   branches:
+    - master
+  pull_request:
+
+jobs:
+  update-licenses:
+    name: Generates a licenses file for the dependencies used in the application and commits the changes
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Generate licenses file
+        uses: nearform/github-action-licenses-export@v1
+        with:
+          licenses-file: src/licenses.json
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: 'chore: update licenses file'
+          add: src/licenses.json
+```

action.yml

@@ -0,0 +1,27 @@
+# See the syntax docs at
+# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions
+
+name: Licenses export
+description: Generates a file with the dependencies used in the application with their respective licenses.
+
+inputs:
+  licenses-file:
+    description: 'Licenses output JSON file'
+    required: false
+    default: 'licenses.json'
+  omit-version:
+    description: 'Omit package versions from the report'
+    required: false
+    default: 'true'
+  production-only:
+    description: 'Only include production packages'
+    required: false
+    default: 'true'
+  direct-dependencies-only:
+    description: 'Only include direct dependencies'
+    required: false
+    default: 'true'
+
+runs:
+  using: 'node16'
+  main: 'dist/index.js'