Skip to content

Commit b1b2bfb

Browse files
authored
README: Add Installation section (#350)
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
1 parent 03995ff commit b1b2bfb

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,20 @@ These methods may be removed in future versions.
5252
* [proxy\_request](#proxy_request)
5353
* [proxy\_response](#proxy_response)
5454

55+
## Installation
56+
57+
This module is located at:
58+
https://luarocks.org/modules/pintsized/lua-resty-http
59+
60+
Install it with:
61+
```
62+
luarocks install lua-resty-http <version> && luarocks install lua-resty-openssl
63+
```
64+
65+
Appending the version to the `luarocks` installation command avoids migration conflicts. The `lua-resty-openssl` package is a prerequisite for all HTTP connections.
66+
67+
**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.
68+
5569
## Usage
5670

5771
There are two basic modes of operation:

0 commit comments

Comments
 (0)