From 27781e22d8fc5bc70e4d989450e08e54b9f5c4db Mon Sep 17 00:00:00 2001
From: Cynthia Kiser <cnk@caltech.edu>
Date: Tue, 10 Dec 2024 16:56:25 -0800
Subject: [PATCH] Maintenance changes

---
 CHANGELOG.md |  2 ++
 Makefile     | 42 ++++++++++++++++++++++++++++++++++++++++++
 README.md    | 11 +++++------
 3 files changed, 49 insertions(+), 6 deletions(-)
 create mode 100644 Makefile

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 997859e..e5fe22d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [unreleased] - YYYY-MM-DD
 
+- Add a Makefile to facilitate releases _Cynthia Kiser_
+
 ## [0.6.0] - 2024-12-10
 
 - Add support for Wagtail 6.2 and 6.3 _Robert Rollins_
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..fdf7105
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,42 @@
+.DEFAULT_GOAL := help
+
+help: ## ⁉️ - Display help comments for each make command
+	@grep -E '^[0-9a-zA-Z_-]+:.*? .*$$'  \
+		$(MAKEFILE_LIST)  \
+		| awk 'BEGIN { FS=":.*?## " }; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'  \
+		| sort
+
+clean:  ## 🧹 Clean up the project
+	python3 setup.py clean --all
+	rm -rf dist
+
+dist:  ## 🔨 Create tar.gz and wheel files for pypi	python3 setup.py clean --all
+	python3 setup.py sdist
+	python3 setup.py bdist_wheel
+
+pypi:  ## 📦 Upload package to PyPi
+	twine upload --repository wagtail-hallo dist/*
+
+lint-server:  ## Lint the server code with flakes8
+	flake8 wagtail_hallo
+
+lint-client:  ## Lint the client code with eslint
+	npm run lint
+
+lint: lint-server lint-client
+
+format-server:  ## Format the server code with black
+	black wagtail_hallo
+
+format-client:  ## Format the client code with prettier
+	npm run format
+
+format: format-server format-client
+
+test-server:  ## Run the Python tests
+	python testmanage.py test
+
+test-client:  ## Run the JavaScript tests
+	npm run test
+
+test: test-server test-client
\ No newline at end of file
diff --git a/README.md b/README.md
index 38ec606..9bc7d1e 100644
--- a/README.md
+++ b/README.md
@@ -25,13 +25,12 @@ This is the legacy rich text editor for the Wagtail CMS. Based on [Hallo.js](htt
 - Django 4.2, 5.0
 - Wagtail 6.2
 
-Please note that only Django >=4.2 are still supported versions of Django. And only Wagtail 5.2 and
-6.3 are still supported as of December 20204. But the wagtail-hallo package should work on the wider
-range of versions mentioned above.
+The wagtail-hallo package should work on the wider range of versions than those mentioned above. But there are a couple of places where changes in Wagtail have caused breaking changes in wagtail-hallo.
 
-If you need support for Wagtail 3.0 while you are upgrading, please use wagtail-hallo 0.2.0. For
-Wagtail 4, use wagtail-hallo 0.3.0. For Wagtail 5, use wagtail-hallo 0.4.0. For Wagtail 6.0 and 6.1,
-use wagtail-hallo 0.5.0
+- If you need support for Wagtail 3.0 while you are upgrading, please use wagtail-hallo 0.2.0.
+- For Wagtail 4, use wagtail-hallo 0.3.0.
+- For Wagtail 5, use wagtail-hallo 0.4.0.
+- For Wagtail 6.0 and 6.1, use wagtail-hallo 0.5.0
 
 ## Installing the Hallo Editor