diff --git a/README.markdown b/README.markdown index 8760094..918ec50 100644 --- a/README.markdown +++ b/README.markdown @@ -1,13 +1,19 @@ CodeIgniter-Dynect API ========================= -Connect to the Dynect API with CodeIgniter (PHP) +Connecting to the Dynect API with CodeIgniter (PHP) +This is an open-source work in progress, and your contribution is appreciated! + +TODO: + The Dynect API doesn't appear to support everything needed, but this is a decently-complete implementation and should get anyone trying to interface with Dynect via PHP a good head start. + The code is very hackish -- there's a lot of copy-paste and the CodeIgniter section is just a repurposed welcome.php -- but the good news is that sections are quite usable on their own. There's no config files, dependencies, or a significant MVC to be concerned about, and so should be decent as PHP sample code of the Dynect API implementation. Installation ------------ -1. Copy system/application/libraries/Dynect_API.php to your application/libraries folder -2. Review the sample code in system/application/controllers/welcome.php +1. Copy system/application/libraries/Dynect_API.php to your CodeIgniter app's application/libraries folder (if applicable, otherwise just use the PHP file as-is.) +2. Review the sample code in system/application/controllers/welcome.php for usage examples. +3. Reference Dynect's API documentation for further information. Config ------