From 5f5331ea0bc4ffed46a030715bab16264c0d2b31 Mon Sep 17 00:00:00 2001
From: Marco Perone <marco.perone@tweag.io>
Date: Fri, 17 Mar 2023 11:14:45 +0100
Subject: [PATCH] add changelog

---
 CHANGELOG.md | 12 ++++++++++++
 README.md    |  4 ++++
 crem.cabal   |  2 ++
 package.yaml |  3 +++
 4 files changed, 21 insertions(+)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..b355869
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [PVP](https://pvp.haskell.org/).
+
+## [0.1.0.0] - 2023-03-17
+
+### Added
+
+- 🎉 everything's new! first release!
diff --git a/README.md b/README.md
index 6716742..857b397 100644
--- a/README.md
+++ b/README.md
@@ -122,6 +122,10 @@ We have a `cabal` flag called `errors` which allows enabling `-Werror`. It has a
 
 In development and CI we use the flag `-f errors` so that we can avoid any warning in the library code.
 
+### Changelog
+
+All changes are tracked in the [`Changelog`](CHANGELOG.md).
+
 ## Project setup
 
 You can find more details on the project setup on [Setup.md](/Setup.md).
diff --git a/crem.cabal b/crem.cabal
index 9eea8a6..9d4bd62 100644
--- a/crem.cabal
+++ b/crem.cabal
@@ -22,6 +22,8 @@ tested-with:
   , GHC ==9.2.7
   , GHC ==9.4.4
   , GHC ==9.6.1
+extra-source-files:
+    CHANGELOG.md
 
 flag errors
   description: enable -Werror
diff --git a/package.yaml b/package.yaml
index 20fa0e8..cd2ddbc 100644
--- a/package.yaml
+++ b/package.yaml
@@ -20,6 +20,9 @@ tested-with:
   - GHC ==9.4.4
   - GHC ==9.6.1
 
+extra-source-files:
+  - CHANGELOG.md
+
 flags:
   errors:
     description: enable -Werror