Add quickstart and examples to readme

README.md

@@ -1,2 +1,88 @@
-php-curl-class
-==============
+# php-curl-class
+
+PHP Curl Class is an object-oriented wrapper of the PHP cURL extension.
+
+### Quick Start and Examples
+
+```php
+require 'Curl.class.php';
+
+$curl = new Curl();
+$curl->get('http://www.example.com/');
+```
+
+```php
+$curl = new Curl();
+$curl->get('http://www.example.com/search', array(
+    'q' => 'keyword',
+));
+```
+
+```php
+$curl = new Curl();
+$curl->post('http://www.example.com/login/', array(
+    'username' => 'myusername',
+    'password' => 'mypassword',
+));
+```
+
+```php
+$curl = new Curl();
+$curl->setBasicAuthentication('username', 'password');
+$curl->setUserAgent('');
+$curl->setReferrer('');
+$curl->setCookie('key', 'value');
+$curl->get('http://www.example.com/');
+
+if ($curl->error) {
+    echo $curl->error_code;
+}
+else {
+    echo $curl->response;
+}
+
+var_dump($curl->request_headers);
+var_dump($curl->response_headers);
+```
+
+```php
+$curl = new Curl();
+$curl->setopt(CURLOPT_RETURNTRANSFER, TRUE);
+$curl->setopt(CURLOPT_SSL_VERIFYPEER, FALSE);
+$curl->get('https://encrypted.example.com/');
+```
+
+```php
+$curl = new Curl();
+$curl->put('http://api.example.com/user/', array(
+    'first_name' => 'Zach',
+    'last_name' => 'Borboa',
+));
+```
+
+```php
+$curl = new Curl();
+$curl->patch('http://api.example.com/profile/', array(
+    'image' => '@path/to/file.jpg',
+));
+```
+
+```php
+$curl = new Curl();
+$curl->delete('http://api.example.com/user/', array(
+    'id' => '1234',
+));
+```
+
+```php
+$curl->close();
+```
+
+```php
+// Example access to curl object.
+curl_set_opt($curl->curl, CURLOPT_USERAGENT, 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1');
+curl_close($curl->curl);
+```
+
+### TODO
+- Implement