From c5a5d63d3c23fb1c6a52d9409c13c125aba27153 Mon Sep 17 00:00:00 2001
From: orhun <orhun@archlinux.org>
Date: Fri, 18 Jun 2021 19:05:43 +0300
Subject: [PATCH] docs(readme): update README.md about new action arguments

---
 README.md | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 19ca2d5..0a55d50 100644
--- a/README.md
+++ b/README.md
@@ -6,21 +6,34 @@ This action generates a changelog based on your Git history using [git-cliff](ht
 
 ### Inputs
 
-* `config`: Path of the configuration file. Default: `"cliff.toml"`
-* `args`: Arguments to pass to git-cliff. Default: `"-v"`
+- `config`: Path of the configuration file. Default: `"cliff.toml"`
+- `args`: Arguments to pass to git-cliff. Default: `"-v"`
 
 ### Outputs
 
-* `changelog`: The generated changelog.
+- `changelog`: Output file that contains the generated changelog.
+
+### Environment
+
+- `OUTPUT`: Output file. Default: `"git-cliff/CHANGELOG.md"`
 
 ### Examples
 
-```
-- name: Changelog Generator
+```yml
+- name: Checkout
+  uses: actions/checkout@v2
+  with:
+    fetch-depth: 0
+- name: Generate a changelog
   uses: orhun/git-cliff-action@v1
+  id: git-cliff
   with:
     config: cliff.toml
     args: --verbose
+  env:
+    OUTPUT: CHANGELOG.md
+- name: Print the changelog
+  run: cat "${{ steps.git-cliff.outputs.changelog }}"
 ```
 
 ## Credits