Added example and descriptions for inputs to readme.

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+* Added example to readme.
+* Added descriptions for input to readme.
+
+
 ## [0.1.2] - 2024-06-26
 
 ### Changed

README.md

@@ -14,5 +14,24 @@
         uses: instructions-d-installation/[email protected]
         with:
           path: <url to git repo or path to directory or config file>
-          options: <options for installation>
+          options: <options for installation (optional)>
+          version: <installation-instruction version (optional)>
+```
+
+### Input
+
+* `path`: Path to directory, file or a remote git repository url containing the config file.
+* `options`: Options as string to pass to ibi cli. (Please check locally if it works.)
+* `version`: Version of installation-instruction to use. If empty, uses the latest version.
+
+
+### Example
+
+```yaml
+    steps:
+      - name: Install from Config File
+        uses: instructions-d-installation/[email protected]
+        with:
+          path: ./install.cfg
+          options: --something
 ```