From 740e3fdf4b6741558f010c9736174fa31a725cfd Mon Sep 17 00:00:00 2001
From: David Coallier <dev@cloudsplit.com>
Date: Thu, 1 Apr 2010 12:29:25 +0100
Subject: [PATCH] Added initial examples to the README file

---
 README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)

diff --git a/README.md b/README.md
index e69de29..4a272ee 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,72 @@
+## Introduction
+This is the PHP API Wrapper that allows developers to access the Capsule CRM api using PHP
+
+## Examples
+
+Get a **party** by party id:
+
+    require_once 'Services/Capsule.php';
+    
+    try {
+        $capsule = new Services_Capsule('appName', 'token');
+        $party   = $capsule->party->get('partyId');
+    } catch (Services_Capsule_Exception $e) {
+        print_r($e);
+    }
+    
+    print_r($party);
+
+Get all **party**:
+
+    require_once 'Services/Capsule.php';
+    
+    try {
+        $capsule = new Services_Capsule('appName', 'token');
+        $parties = $capsule->party->getList();
+    } catch (Services_Capsule_Exception $e) {
+        print_r($e);
+    }
+    
+    print_r($parties);
+    
+Get a list of people in a **party**:
+
+    require_once 'Services/Capsule.php';
+    
+    try {
+        $capsule = new Services_Capsule('appName', 'token');
+        $people  = $capsule->party->people->getAll('partyId');
+    } catch (Services_Capsule_Exception $e) {
+        print_r($e);
+    }
+
+    print_r($people);
+
+
+Add a new history note to a **party**:
+
+    require_once 'Services/Capsule.php';
+
+    try {
+        $capsule = new Services_Capsule('appName', 'token');
+        $note  = $capsule->party->history->addNote(
+            'partyId', 'This is a test note.'
+        );
+    } catch (Services_Capsule_Exception $e) {
+        print_r($e);
+    }
+
+    var_dump($note); // This will be true if success
+    
+Get a list of **opportunity**:
+
+    require_once 'Services/Capsule.php';
+
+    try {
+        $capsule = new Services_Capsule('appName', 'token');
+        $opps  = $capsule->opportunity->getList();
+    } catch (Services_Capsule_Exception $e) {
+        print_r($e);
+    }
+
+    print_r($opps);
\ No newline at end of file