Merge pull request #7 from thc202/add-changelog

Add changelog and mention exit value

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this GitHub action will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased]
+### Added
+ - Allow to run local or remote Automation Framework plans.
+
+[Unreleased]: https://github.com/zaproxy/action-af/compare/b9d155d1940506fe73c356194bbc0dc4f45789f4...HEAD

README.md

@@ -15,6 +15,10 @@ A GitHub Action for running [ZAP Automation Framework](https://www.zaproxy.org/d
 
 **Optional** Additional [command line options](https://www.zaproxy.org/docs/desktop/cmdline/) for ZAP.
 
+## Exit Value
+
+The action will exit with the value of the plan, as indicated in the [Automation Framework documentation](https://www.zaproxy.org/docs/automate/automation-framework/#exit-value).
+
 ## Files
 
 Files created with the plan that need to be used after the plan has finished should be saved to the `/zap/wrk/` directory, which is mapped to the [GITHUB_WORKSPACE](https://docs.github.com/en/actions/learn-github-actions/variables) directory.