Preparing for release

Author: Baguage

CHANGELOG.txt

@@ -1,3 +1,7 @@
+0.3.0 01/14/2016
+  * Renamed parameters for consistency: library_id to LibraryID, panel_id to PanelID, name to Name
+  * New example: create panel, add recipient, send survey, delete panel
+
 0.2.0 01/05/2016
   * Improved test coverage up to 80%
   * importPanel function now automatically computes Email, LastName, FirstName and ExternalRef parameters

README.md

@@ -8,14 +8,20 @@ PyQualtrics
 
 Unofficial python SDK for Qualtrics API
 
+# API Documentation
+
+The Qualtrics REST API allows you to query our system using a simple URL syntax. All requests are simple GET or POST requests that return XML or JSON. 
+Official API documenation is available on https://survey.qualtrics.com/WRAPI/ControlPanel/docs.php
+This library uses API v2.5
+
 # System requirements
 
 Python 2.7 only. Requires setuptools. 
 Run `python ez_setup.py` command if you do not have setuptools installed in your virtual environment.
 
 # Installation
 
-Install using pip:
+Install the latest release using pip:
 
 `pip install pyqualtrics`
 
@@ -31,6 +37,9 @@ Access is available for your account.
 Please refer to http://www.qualtrics.com/university/researchsuite/developer-tools/api-integration/qualtrics-rest-api/ 
 for information on how to get your API Token and other Qualtrics IDs.
 
+This is how you get get list of all responses to a survey. A python dictionary is returned by getLegacyResponseData
+function
+
 ```python
 from pyqualtrics import Qualtrics
 
@@ -56,7 +65,7 @@ QUALTRICS_LIBRARY_ID - Library ID
 
 Please refer to https://survey.qualtrics.com/WRAPI/ControlPanel/docs.php#authentication_2.5 for additional information
 on how to get your API Token. Library ID can be found in the 'Qualtrics IDs' section.
-If either of these variables is not defined, tests won't start at all.
+If one of these variables is not defined, tests won't start at all.
 
 If you want to run full test suite, you may want to create a survey, a message and one response in your Qualtrics account.
 QUALTRICS_SURVEY_ID, QUALTRICS_RESPONSE_ID and QUALTRICS_MESSAGE_ID variable should be set to activate those tests

setup.py

@@ -28,7 +28,7 @@
 
 setup(
     name="pyqualtrics",
-    version="0.2.0",
+    version="0.3.0",
     author="Alex Vyushkov",
     author_email="[email protected]",
     description="Unofficial python SDK for Qualtrics API",