Skip to content

Commit c69cb58

Browse files
committed
doc: added annotations about the compatibilities for blocking phase
1 parent 0358263 commit c69cb58

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.markdown

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ lua-resty-requests - Yet Another HTTP Library for OpenResty.
55

66
![Build Status](https://travis-ci.org/tokers/lua-resty-requests.svg?branch=master)
77

8+
```bash
9+
resty -e 'print(require "resty.requests".get("https://github.com", { stream = false}).content)'
10+
```
11+
812
Table of Contents
913
=================
1014

@@ -35,6 +39,11 @@ Status
3539

3640
This Lua module now can be considered as production ready.
3741

42+
Note since the `v0.7.1` release, this module started using lua-resty-socket,
43+
for working in the non-yieldable phases, but still more efforts are needed,
44+
so **DONOT** use it in the `init` or `init_worker` phases (or other
45+
non-yieldable phases).
46+
3847
Features
3948
========
4049

0 commit comments

Comments
 (0)