-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4a4f4d2
commit 9f9bed5
Showing
1 changed file
with
64 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 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). | ||
| [MIT](LICENSE) |