From fb126bef4994bba732828e957a3020df53b59373 Mon Sep 17 00:00:00 2001
From: Cathal Horan <cathal.horan@intercom.io>
Date: Tue, 29 Aug 2017 10:44:33 +0100
Subject: [PATCH] Adding readme updates for rate limit PR

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

diff --git a/README.md b/README.md
index b4ae505..d434d57 100644
--- a/README.md
+++ b/README.md
@@ -332,6 +332,15 @@ $client->notes->getNotes([
 // Get a single Note by id
 $client->notes->getNote("42");
 ```
+## Rate Limits
+Rate limit info is passed via the rate limit headers.
+You can access this information as follows:
+```
+$rate_limit = $intercom->getRateLimitDetails();
+print("{$rate_limit['remaining']} {$rate_limit['limit']} \n");
+print_r($rate_limit['reset_at']->format(DateTime::ISO8601));
+```
+For more info on rate limits and these headers please see the [API ref docs](https://developers.intercom.com/reference#rate-limiting)
 
 ## Pagination