From 9f9bed5bdf695af0e5d67ba1a830cffc7cedc4df Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pedro=20Rog=C3=A9rio?= <pinceladasdaweb@hotmail.com>
Date: Tue, 3 Mar 2015 15:22:06 -0300
Subject: [PATCH] Update Readme

---
 README.md | 84 ++++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 64 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index ca69181..7ad7481 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,88 @@
-[Tweetlight](http://www.pinceladasdaweb.com.br/blog/uploads/tweetlight/)
-==========
+# [Tweetlight](http://www.pinceladasdaweb.com.br/blog/uploads/tweetlight/)
 
-Display your latest tweets with pure JavaScript and PHP OAuth Library.
+> Display your latest tweets with pure JavaScript and PHP OAuth Library.
 
-##Usage
+## How to Configure
 
-1 - Add the code below to your HTML, where the latest tweets should appear:
+1 - In your HTML file where you want the tweets appear, insert a `<ul>` tag with an id or class, to be used by JavaScript:
 
 ```html
-<ul id="tweets"></ul>
+<ul class="timeline"></ul>
 ```
 
 2 - Paste right before your page's closing `</body>` tag:
 
 ```html
-<script type="text/javascript" src="src/tweetlight.min.js"></script>
+<script type="text/javascript" src="path/to/tweetlight.min.js"></script>
 ```
 
-3 - From within a script tag or a JS file
+3 - From within a script tag or a JS file:
+
+3.1 - For display a user timeline use:
+
+```javascript
+Tweetlight.init({
+    username: 'pinceladasdaweb',    // Twitter username
+    container: '.timeline',         // domNode to attach to
+    counter: 5,                     // Number of tweets to display
+    onComplete: function() {
+        console.log('Awesome APP'); // Callback to execute after fetch tweets. Not required, use if necessary.
+    }
+});
+```
+
+3.2 - For display hashtags use:
+
+```javascript
+Tweetlight.init({
+    hashtag: '#html5',              // Twitter hashtag
+    container: '.hashtags',         // domNode to attach to
+    counter: 5,                     // Number of tweets to display
+    onComplete: function() {
+        console.log('Awesome APP'); // Callback to execute after fetch tweets. Not required, use if necessary.
+    }
+});
+```
+
+3.3 - You can also load the script via AMD:
 
 ```javascript
+require(["/path/to/tweetlight.min"], function(Tweetlight) {
     Tweetlight.init({
-        username: 'pinceladasdaweb',    // Twitter username
-        container: '#tweets',           // domNode to attach to
-        count: 4,                       // Number of tweets to display
-        onComplete: function(){
-            console.log('Awesome APP'); // Callback to execute after fetch tweets
-        }
+        username: 'pinceladasdaweb',
+        container: '.timeline',
+        counter: 5
     });
+});
 ```
 
-4 - In the tweets.php file, complete the [Twitter OAuth settings] (https://dev.twitter.com/docs/auth/oauth/faq)
+4 - In the config.php [`config.php`](api/config.php) file, complete the [Twitter OAuth settings](https://dev.twitter.com/docs/auth/oauth/faq)
 
 ```php
-$CONSUMER_KEY = '';
-$CONSUMER_SECRET = '';
-$ACCESS_TOKEN = '';
+$CONSUMER_KEY        = '';
+$CONSUMER_SECRET     = '';
+$ACCESS_TOKEN        = '';
 $ACCESS_TOKEN_SECRET = '';
 ```
 
-##Important Note
+## Important Note
+
+It is mandatory to file cacert.pem be on the same level/directory that codebird.php file because Twitter requires [secure connections in their API](https://dev.twitter.com/discussions/24239).
+
+## Browser support
+
+![IE](https://cloud.githubusercontent.com/assets/398893/3528325/20373e76-078e-11e4-8e3a-1cb86cf506f0.png) | ![Chrome](https://cloud.githubusercontent.com/assets/398893/3528328/23bc7bc4-078e-11e4-8752-ba2809bf5cce.png) | ![Firefox](https://cloud.githubusercontent.com/assets/398893/3528329/26283ab0-078e-11e4-84d4-db2cf1009953.png) | ![Opera](https://cloud.githubusercontent.com/assets/398893/3528330/27ec9fa8-078e-11e4-95cb-709fd11dac16.png) | ![Safari](https://cloud.githubusercontent.com/assets/398893/3528331/29df8618-078e-11e4-8e3e-ed8ac738693f.png)
+--- | --- | --- | --- | --- |
+IE 8+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
+
+## Contributing
+
+Check [CONTRIBUTING.md](https://github.com/pinceladasdaweb/tweetlight/blob/master/CONTRIBUTING.md) for more information.
+
+## History
+
+Check [Releases](https://github.com/pinceladasdaweb/tweetlight/releases) for detailed changelog.
+
+## License
 
-It is mandatory to file cacert.pem be on the same level/directory that codebird.php file because Twitter requires [secure connections in their API] (https://dev.twitter.com/discussions/24239).
\ No newline at end of file
+[MIT](LICENSE)
\ No newline at end of file