Permalink
Browse files

README

  • Loading branch information...
1 parent f4ca9d1 commit 2fc8aa807017745c18a829620b1ccf525b5e3388 @nopolabs committed Feb 22, 2012
Showing with 16 additions and 5 deletions.
  1. +16 −5 README.md
View
@@ -1,17 +1,28 @@
-Gilt API
-========
+Gilt API PHP
+============
-Gilt API is ...
+gilt_api_php provides a PHP client for the Gilt Groupe APIs.
+
+The Gilt Groupe APIs give outside developers with the ability to build applications that display information about Gilt Groupe's upcoming sales and the products available in those sales.
Requirements
------------
-PHP 5.2.7
-PHPUnit 3.4.5
+PHP 5.2.7+
+
+PHPUnit 3.4.5+
Documentation
-------------
+https://dev.gilt.com/
Usage
-----
+ require 'gilt_api.php';
+ require 'lib/http_get.php';
+
+ $api_key = <your_gilt_api_key>;
+ $http_get = new HttpGet();
+ $gilt = new Gilt($api_key, $http_get);
+ $sales = $gilt->getActiveSales();

0 comments on commit 2fc8aa8

Please sign in to comment.