iOS / asi-http-request

Go to a project
Toggle navigation Toggle navigation pinning
Ben Copsey
d6e24fbb 1 parent 62f3a7a3

Update readme for release

Inline Side-by-side
Showing 1 changed file with 8 additions and 31 deletions
1 -To do: 1 +ASIHTTPRequest is an easy to use wrapper around the CFNetwork API that makes some of the more tedious aspects of communicating with web servers easier. It is written in Objective-C and works in both Mac OS X and iPhone applications.
2 -Add note about not locking main thread when using progress  
3 -Replace this with a link to the docs?  
4 -Add to release notes - lots of leaks fixed, and it it releases temporary stuff during a request rather than waiting until the end  
5 2
6 - 3 +It is suitable performing basic HTTP requests and interacting with REST-based services (GET / POST / PUT / DELETE). The included ASIFormDataRequest subclass makes it easy to submit POST data and files using multipart/form-data.
7 -[NEW!] Documentation is available at: http://allseeing-i.com/asi-http-request  
8 -  
9 -ASIHTTPRequest is an easy to use wrapper around the CFNetwork API that makes some of the more tedious aspects of communicating with web servers easier.  
10 -  
11 -It is suitable for when you want to submit data to an existing web form, or don't want to mess around with SOAP or XML-RPC.  
12 4
13 It provides: 5 It provides:
14 - 6 +* A straightforward interface for submitting data to and fetching data from webservers
15 -* A straightforward interface for submitting data to (GET & POST) and fetching data from webservers 7 +* Download data to memory or directly to a file on disk(i)
16 -  
17 * The ability to submit files on local drives as part of POST data, compatible with the HTML file input mechanism 8 * The ability to submit files on local drives as part of POST data, compatible with the HTML file input mechanism
18 -  
19 * Easy access to request and response HTTP headers 9 * Easy access to request and response HTTP headers
20 - 10 +* Ability for setting up progress delegates (NSProgressIndicators and UIProgressViews) to show information about download AND upload progress
21 -* Ability for setting up progress delegates (e.g. NSProgressIndicators) to show information about download AND upload progress 11 +* Auto-magic management of upload and download progress indicators for operation queues
22 -  
23 * Basic authentication (username and password) support, credentials are automatically for the duration of a session, and can be stored for later in the Keychain. 12 * Basic authentication (username and password) support, credentials are automatically for the duration of a session, and can be stored for later in the Keychain.
24 - 13 +* Cookie support
25 -* Cookie support - read and write cookies, and re-use them in other requests  
26 -  
27 * Based on NSOperation to make queuing requests and background operation easy 14 * Based on NSOperation to make queuing requests and background operation easy
28 -  
29 * Basic unit tests (more to come!) 15 * Basic unit tests (more to come!)
30 16
31 -ASIHTTPRequest comes as part of a simple application that demonstrates many of the features above, just look at AppDelegate.m for good pointers on basic usage, or read the comments in ASIHTTPRequest.h for more detail. 17 +Documentation is available "here":http://allseeing-i.com/ASI-HTTP-REQUEST.
32 -  
33 -ASIHTTPRequest is partly based on code from Apple's ImageClient code samples, so if it doesn't meet your needs, take a look at their CFNetwork examples for more.  
34 -  
35 -ASIHTTPRequest is my first open source Objective-C code. I hope to expand the class and example application further (unit tests, maybe even iphone examples...) in the coming months. If you find it helpful, please do get in touch!  
36 -  
37 -To do:  
38 -More unit tests  
39 -Add SOAP example  
40 -See if Digest Authentication works