Added README.md file

.github/workflows/tests.yml

@@ -23,8 +23,8 @@ jobs:
       - name: Provision VM
         uses: ./
         with:
-          cpus: 4
           box: ${{ matrix.box }}
+          cpus: 4
           save_box_to_cache: true
           use_cached_box: true
 

README.md

@@ -0,0 +1,29 @@
+# FreeBSD Vagrant Action
+
+**This value for [runs-on](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on) must always be set to `macos-latest` in order to use this action.**
+
+This action allows the running of command-line programs via the `bash` shell of FreeBSD VMs provisioned with Vagrant using the [run](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun) keyword. This also works with composite actions which exclusively use the `run` keyword (and/or call other composite actions which also do so.)
+
+#### *This action is currently only tested with these boxes (but will probably also work with others):*
+  * `freebsd/FreeBSD-12.4-RELEASE`
+  * `freebsd/FreeBSD-13.2-RELEASE`
+  * `generic/freebsd12`
+  * `generic/freebsd13`
+
+# Usage
+<!-- start usage -->
+1. Provision a `FreeBSD VM` using the specified `box` (with 2 CPUs & 2GB of RAM)
+    ```yaml
+    - name: Provision VM
+      uses: hummeltech/[email protected]
+      with:
+        box: freebsd/FreeBSD-12.4-RELEASE
+        cpus: 2
+        memory: 2048
+    ```
+2. Execute a command using the `run` keyword
+    ```yaml
+    - name: Display the contents of /etc/os-release
+      run: cat /etc/os-release
+    ```
+<!-- end usage -->

action.yml

@@ -1,5 +1,6 @@
 ---
 name: Start Vagrant Box
+description: Allow running command-line programs via bash shell of FreeBSD VMs provisioned with Vagrant using the run keyword.
 
 inputs:
   box: