Skip to content

Commit 73d1f31

Browse files
committed
Update README.md
1 parent 980af35 commit 73d1f31

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,36 @@
33
[![Coverage Status](https://coveralls.io/repos/Lua-cURL/Lua-cURLv3/badge.png?branch=master)](https://coveralls.io/r/Lua-cURL/Lua-cURLv3?branch=master)
44
[![Licence](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)
55

6+
##Status
7+
8+
This module include three layer
9+
10+
1. `lcurl` module provide low level pure C binding to libcurl.<br/>
11+
Almost ready and needs tests. I have no plans to change this API.
12+
13+
2. `cURL` module provide compatibility for Lua-cURLv2 API.<br/>
14+
Almost ready and needs tests.
15+
16+
3. `cURL` module provide new high level API.<br/>
17+
In fact for now it provide `lcurl` API directly and needed to redesign.<br/>
18+
19+
620
## Documentation
7-
[API](http://moteus.github.com/lcurl)<br/>
8-
Also library provide `lcurl.cURL` compatibility module for [Lua-cURL](http://lua-curl.github.io/Lua-cURL) binding.
21+
[lcurl API](http://moteus.github.com/lcurl)<br/>
22+
[Lua-cURLv2 API](http://lua-curl.github.io/Lua-cURL)<br/>
23+
Lua-cURLv3 API - TODO
924

10-
## Why one more curl binding
25+
##
1126

12-
Existing [Lua-cURL](http://lua-curl.github.io/Lua-cURL) binding has several problems:
27+
Lua-cURLv2 binding has several problems:
1328

1429
* it can not return error codes but just raise Lua errors
1530
* it raise Lua error from callback that may result resource leak in libcurl
1631
* it does not provide building multipart/formdata explicitly
1732
* it has memory leak when send multipart/formdata
1833
* it does not save string for curl options that may result crush in libcurl
1934
* there no way to get result for operations in multi interface (e.g. if one of easy operation fail you can not get result code/error message)
20-
* you can not use multi interface for upload operation
35+
* you can not use multi interface for upload operation (?)
2136
* you can not use your own callback function to perform operation with multi interface
2237
* you can not pass your context to callback functions
2338

0 commit comments

Comments
 (0)