From f9fcbef1fdd70735fcad733ad0e83dcc83e90117 Mon Sep 17 00:00:00 2001
From: Eshaan Bansal <eshaan7bansal@gmail.com>
Date: Mon, 20 Sep 2021 15:26:40 +0530
Subject: [PATCH] chore: add CHANGELOG.md

---
 .github/CHANGELOG.md | 32 ++++++++++++++++++++++++++++++++
 README.md            |  8 +++++---
 2 files changed, 37 insertions(+), 3 deletions(-)
 create mode 100644 .github/CHANGELOG.md

diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md
new file mode 100644
index 0000000..7a410cb
--- /dev/null
+++ b/.github/CHANGELOG.md
@@ -0,0 +1,32 @@
+# Changelog
+
+**[Get it on PyPi](https://pypi.org/project/Flask-Shell2HTTP/)**
+
+## [v1.7.0](https://github.com/eshaan7/Flask-Shell2HTTP/releases/tag/v1.7.0)
+
+**For you:**
+- Deps: Support for both Flask version 1.x and 2.x.
+- Feature: The `key` and `result_url` attributes are returned in response even if error is raised (if and when applicable) (See [#25](https://github.com/eshaan7/Flask-Shell2HTTP/issues/25)).
+- Docs: Add info about `force_unique_key` option to quickstart guide.
+
+**Internal:**
+- Much better and improved test cases via tox matrix for both major flask versions, 1.x and 2.x.
+- Much better overall type hinting.
+
+## [v1.6.0](https://github.com/eshaan7/Flask-Shell2HTTP/releases/tag/v1.6.0)
+
+Added support for a new parameter `force_unique_key` in the POST request. 
+
+```json
+    "force_unique_key": {
+      "type": "boolean",
+      "title": "Flag to enable/disable internal rate limiting mechanism",
+      "description": "By default, the key is the SHA1 sum of the command + args POSTed to the API. This is done as a rate limiting measure so as to prevent multiple jobs with same parameters, if one such job is already running. If force_unique_key is set to true, the API will bypass this default behaviour and a psuedorandom key will be returned instead",
+      "default": false
+    }
+```
+
+See [post-request-options configuration](https://flask-shell2http.readthedocs.io/en/latest/Configuration.html#post-request-options) in docs for more info.
+
+
+_For prior versions, see directly [here](https://github.com/eshaan7/Flask-Shell2HTTP/releases/tag/)._ 
\ No newline at end of file
diff --git a/README.md b/README.md
index 2053342..55c067e 100644
--- a/README.md
+++ b/README.md
@@ -34,14 +34,15 @@ A minimalist [Flask](https://github.com/pallets/flask) extension that serves as
 > Note: This extension is primarily meant for executing long-running
 > shell commands/scripts (like nmap, code-analysis' tools) in background from an HTTP request and getting the result at a later time.
 
+
 ## Documentation
 
 [![Documentation Status](https://readthedocs.org/projects/flask-shell2http/badge/?version=latest)](https://flask-shell2http.readthedocs.io/en/latest/?badge=latest)
 
-Read the [Quickstart](https://flask-shell2http.readthedocs.io/en/stable/Quickstart.html) 
-from the [documentation](https://flask-shell2http.readthedocs.io/) to get started!
+- Read the [Quickstart](https://flask-shell2http.readthedocs.io/en/stable/Quickstart.html) from the [documentation](https://flask-shell2http.readthedocs.io/) to get started!
+- I also highly recommend the [Examples](https://flask-shell2http.readthedocs.io/en/stable/Examples.html) section.
+- [CHANGELOG](https://github.com/intelowlproject/IntelOwl/blob/master/.github/CHANGELOG.md).
 
-I highly recommend the [Examples](https://flask-shell2http.readthedocs.io/en/stable/Examples.html) section.
 
 ## Quick Start
 
@@ -134,6 +135,7 @@ Returns result in JSON,
 }
 ```
 
+
 ## Inspiration
 
 This was initially made to integrate various command-line tools easily with [Intel Owl](https://github.com/intelowlproject/IntelOwl), which I am working on as part of Google Summer of Code.