From 9d6ca31ab293a28369591b8fe6274eab827a96f1 Mon Sep 17 00:00:00 2001 From: Sebastian Parschauer Date: Tue, 11 Aug 2026 09:39:53 +0200 Subject: [PATCH] README: Add Installation section Show how to install this package before using it. Also add a note that OPM is dead and we cannot upload new versions there. Show that lua-resty-openssl is a prerequisite for all HTTP connections. Reported-by: Luca Perna <12624410+MrMadClown@users.noreply.github.com> Closes #349 --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index ca977a2..baf5f67 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,20 @@ These methods may be removed in future versions. * [proxy\_request](#proxy_request) * [proxy\_response](#proxy_response) +## Installation + +This module is located at: +https://luarocks.org/modules/pintsized/lua-resty-http + +Install it with: +``` +luarocks install lua-resty-http && luarocks install lua-resty-openssl +``` + +Appending the version to the `luarocks` installation command avoids migration conflicts. The `lua-resty-openssl` package is a prerequisite for all HTTP connections. + +**Note**: The [OpenResty Package Manager (OPM) alternative](https://opm.openresty.org/package/pintsized/lua-resty-http/) is dead. No new versions can be uploaded there. Please migrate to `luarocks` instead. + ## Usage There are two basic modes of operation: