From 03c93796b7e85d8df4d1aaa333acbdd32341d2b5 Mon Sep 17 00:00:00 2001
From: Thijs Schreijer <thijs@thijsschreijer.nl>
Date: Fri, 18 Sep 2020 09:06:05 +0200
Subject: [PATCH] chore(*) rename readme, add release instructions

---
 readme.md => README.md | 11 +++++++++++
 config.ld              |  2 +-
 2 files changed, 12 insertions(+), 1 deletion(-)
 rename readme.md => README.md (96%)

diff --git a/readme.md b/README.md
similarity index 96%
rename from readme.md
rename to README.md
index af7f6a2b..8d94e4ac 100644
--- a/readme.md
+++ b/README.md
@@ -91,6 +91,17 @@ for the complete API.
 
 Versioning is strictly based on [Semantic Versioning](https://semver.org/)
 
+### Releasing new versions:
+
+* update changelog below (PR's should be merged including a changelog entry)
+* based on changelog determine new SemVer version
+* create a new rockspec
+* render the docs using `ldoc` (don't do this within PR's)
+* commit as "release x.x.x" (do not include rockspec revision)
+* tag the commit with "x.x.x" (do not include rockspec revision)
+* push commit and tag
+* upload rock to luarocks: `luarocks upload rockspecs/[name] --api-key=abc`
+
 ### 1.6.3 (06-Sep-2023)
 
 * Feature: Added support for https_sni [#49](https://github.com/Kong/lua-resty-healthcheck/pull/49) (backport)
diff --git a/config.ld b/config.ld
index 70432802..192b8cc8 100644
--- a/config.ld
+++ b/config.ld
@@ -4,7 +4,7 @@ description='Provides active and passive healthchecks (http and tcp) for OpenRes
 format='discount'
 file='./lib/'
 dir='docs'
-readme='readme.md'
+readme='README.md'
 sort=true
 sort_modules=true
 all=false